Methods

{
  "name": "OglRenderingSRGB",
  "namespace": "sofa::gl::component::shader",
  "module": "Sofa.GL.Component.Shader",
  "include": "sofa/gl/component/shader/OglRenderingSRGB.h",
  "doc": "Set the current visual context framebuffer with SRGB.\n\nThe utility to enable/disable sRGB rendering",
  "inherits": [
    "VisualManager"
  ],
  "templates": [],
  "data_fields": [],
  "links": [],
  "methods": [
    {
      "name": "fwdDraw",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "core::visual::VisualParams *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "bwdDraw",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "core::visual::VisualParams *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    }
  ],
  "description": "The `OglRenderingSRGB` component is part of the Sofa.GL.Component.Shader module and belongs to the `sofa::gl::component::shader` namespace. It serves to manage the visual context's framebuffer for SRGB rendering, enabling or disabling this feature as needed. This component inherits from `VisualManager`, which suggests it handles drawing operations in the SOFA framework’s graphical pipeline.\n\nThrough its API, `OglRenderingSRGB` provides methods to control forward (`fwdDraw`) and backward (`bwdDraw`) rendering steps, both of which accept a pointer to a `core::visual::VisualParams` object. These methods are virtual but not pure virtual, indicating that they can be overridden in derived classes for custom behavior.\n\nThe purpose of this component is to enhance the visual quality by enabling SRGB correction during rendering, ensuring accurate color representation on modern displays.",
  "maths": "The `OglRenderingSRGB` component in the SOFA framework is focused on graphical rendering and does not involve any mathematical or physical formulations related to Finite Element Method (FEM) simulations. Its primary role is to manage the visual context's framebuffer for SRGB color correction, which enhances the visual quality of rendered images by ensuring accurate color representation on modern displays.\n\nGiven this focus on graphical operations, there are no governing equations or operators such as mass matrix \\(M\\), stiffness matrix \\(K\\), internal force \\(f_{int}\\), residual \\(R\\), constitutive laws, kinematic laws, strain measures, stress tensors, hyperelastic potentials, damping models, constraint Jacobians, etc., that this component implements or contributes to in the context of FEM.\n\nThe component's methods `fwdDraw` and `bwdDraw` are part of the graphical pipeline and do not influence any numerical methods or discretization choices related to computational mechanics. They simply control forward and backward rendering steps, ensuring SRGB correction is applied as needed during these operations.",
  "abstract": "The `OglRenderingSRGB` component manages SRGB rendering in the visual context of SOFA simulations, enabling accurate color representation during forward (`fwdDraw`) and backward (`bwdDraw`) drawing operations.",
  "sheet": "\n# OglRenderingSRGB\n\n## Overview\nThe `OglRenderingSRGB` component is part of the Sofa.GL.Component.Shader module and belongs to the `sofa::gl::component::shader` namespace. It inherits from `VisualManager`, indicating its role in managing graphical operations within SOFA simulations. Specifically, this component enables or disables SRGB rendering during forward (`fwdDraw`) and backward (`bwdDraw`) drawing steps.\n\n## Practical Notes\nThe `OglRenderingSRGB` component enhances visual quality by ensuring accurate color representation on modern displays through SRGB correction. It is essential to configure the visual context appropriately for optimal display performance, particularly when working with high-dynamic-range (HDR) content or specific lighting conditions."
}