Murl::Graph::IUniversalMaterial Interface Referenceabstract
The IUniversalMaterial graph node interface. More...
#include "murl_graph_i_universal_material.h"
Inheritance diagram for Murl::Graph::IUniversalMaterial:
Public Member Functions | |
| virtual IUniversalProgramNodeTarget * | GetUniversalProgramNodeTarget ()=0 |
| Get the mutable Graph::IUniversalProgramNodeTarget container. More... | |
| virtual const IUniversalProgramNodeTarget * | GetUniversalProgramNodeTarget () const =0 |
| Get the constant Graph::IUniversalProgramNodeTarget container. More... | |
 Public Member Functions inherited from Murl::Graph::IMaterial | |
| virtual INode * | GetNodeInterface ()=0 |
| Get the mutable Graph::INode interface. More... | |
| virtual const INode * | GetNodeInterface () const =0 |
| Get the constant Graph::INode interface. More... | |
| virtual IMaterialNodeTarget * | GetSubMaterialNodeTarget ()=0 |
| Get the mutable container holding the optional child materials. More... | |
| virtual const IMaterialNodeTarget * | GetSubMaterialNodeTarget () const =0 |
| Get the constant container holding the optional child materials. More... | |
| virtual IMaterialNodeTarget * | GetSubDepthMaterialNodeTarget ()=0 |
| Get the mutable container holding the optional child depth materials. More... | |
| virtual const IMaterialNodeTarget * | GetSubDepthMaterialNodeTarget () const =0 |
| Get the constant container holding the optional child depth materials. More... | |
| virtual IProgramNodeTarget * | GetProgramNodeTarget ()=0 |
| Get the mutable Graph::IProgramNodeTarget container. More... | |
| virtual const IProgramNodeTarget * | GetProgramNodeTarget () const =0 |
| Get the constant Graph::IProgramNodeTarget container. More... | |
| virtual Bool | SetVisibleFaces (IEnums::PolygonFaces faces)=0 |
| Set which faces of a triangle are visible for rendering. More... | |
| virtual IEnums::PolygonFaces | GetVisibleFaces () const =0 |
| Check which faces of a triangle are visible for rendering. More... | |
| virtual Bool | SetColorBufferMode (IEnums::ColorBufferMode mode)=0 |
| Set the material's color buffer access mode. More... | |
| virtual IEnums::ColorBufferMode | GetColorBufferMode () const =0 |
| Get the material's color buffer access mode. More... | |
| virtual Bool | SetColorBufferMask (IEnums::ColorBufferMask mask)=0 |
| Set the material's color buffer mask. More... | |
| virtual IEnums::ColorBufferMask | GetColorBufferMask () const =0 |
| Get the material's color buffer mask. More... | |
| virtual Bool | SetDepthBufferMode (IEnums::DepthBufferMode mode)=0 |
| Set the material's depth buffer access mode. More... | |
| virtual IEnums::DepthBufferMode | GetDepthBufferMode () const =0 |
| Get the material's depth buffer access mode. More... | |
| virtual Bool | SetDepthBufferMask (IEnums::DepthBufferMask mask)=0 |
| Set the material's depth buffer mask. More... | |
| virtual IEnums::DepthBufferMask | GetDepthBufferMask () const =0 |
| Get the material's depth buffer mask. More... | |
| virtual Bool | SetDepthTestFunction (IEnums::DepthTestFunction function)=0 |
| Set the material's depth test function. More... | |
| virtual IEnums::DepthTestFunction | GetDepthTestFunction () const =0 |
| Get the material's depth test function. More... | |
| virtual Bool | SetStencilBufferMode (IEnums::StencilBufferMode mode)=0 |
| Set the material's stencil buffer access mode. More... | |
| virtual IEnums::StencilBufferMode | GetStencilBufferMode () const =0 |
| Get the material's stencil buffer access mode. More... | |
| virtual Bool | SetStencilBufferMask (IEnums::StencilBufferMask mask)=0 |
| Set the material's stencil buffer mask. More... | |
| virtual IEnums::StencilBufferMask | GetStencilBufferMask () const =0 |
| Get the material's stencil buffer mask. More... | |
| virtual Bool | SetStencilTestFunction (IEnums::StencilTestFunction frontFunction, IEnums::StencilTestFunction backFunction)=0 |
| Set the material's stencil test functions. More... | |
| virtual IEnums::StencilTestFunction | GetFrontStencilTestFunction () const =0 |
| Set the material's stencil test function for front-facing primitives. More... | |
| virtual IEnums::StencilTestFunction | GetBackStencilTestFunction () const =0 |
| Set the material's stencil test function for back-facing primitives. More... | |
| virtual Bool | SetStencilTestReferenceValue (UInt32 frontValue, UInt32 backValue)=0 |
| Set the material's stencil test reference values. More... | |
| virtual UInt32 | GetFrontStencilTestReferenceValue () const =0 |
| Get the material's stencil test reference value for testing front-facing primitives. More... | |
| virtual UInt32 | GetBackStencilTestReferenceValue () const =0 |
| Get the material's stencil test reference value for testing back-facing primitives. More... | |
| virtual Bool | SetStencilTestMask (UInt32 frontMask, UInt32 backMask)=0 |
| Set the material's stencil test masks. More... | |
| virtual UInt32 | GetFrontStencilTestMask () const =0 |
| Get the material's stencil test mask for front-facing primitives. More... | |
| virtual UInt32 | GetBackStencilTestMask () const =0 |
| Get the material's stencil test mask for back-facing primitives. More... | |
| virtual Bool | SetStencilBufferActionForFailedStencilTest (IEnums::StencilBufferAction frontAction, IEnums::StencilBufferAction backAction)=0 |
| Set the actions to be performed if the stencil test fails. More... | |
| virtual IEnums::StencilBufferAction | GetFrontStencilBufferActionForFailedStencilTest () const =0 |
| Get the front-facing primitive stencil buffer action for failed stencil tests. More... | |
| virtual IEnums::StencilBufferAction | GetBackStencilBufferActionForFailedStencilTest () const =0 |
| Get the back-facing primitive stencil buffer action for failed stencil tests. More... | |
| virtual Bool | SetStencilBufferActionForFailedDepthTest (IEnums::StencilBufferAction frontAction, IEnums::StencilBufferAction backAction)=0 |
| Set the actions to be performed if the stencil test passes, but the depth test fails. More... | |
| virtual IEnums::StencilBufferAction | GetFrontStencilBufferActionForFailedDepthTest () const =0 |
| Get the front-facing primitive stencil buffer action for failed depth tests. More... | |
| virtual IEnums::StencilBufferAction | GetBackStencilBufferActionForFailedDepthTest () const =0 |
| Get the back-facing primitive stencil buffer action for failed depth tests. More... | |
| virtual Bool | SetStencilBufferActionForPassedDepthTest (IEnums::StencilBufferAction frontAction, IEnums::StencilBufferAction backAction)=0 |
| Set the actions to be performed if both the stencil test and the depth test pass. More... | |
| virtual IEnums::StencilBufferAction | GetFrontStencilBufferActionForPassedDepthTest () const =0 |
| Get the front-facing primitive stencil buffer action for passed depth tests. More... | |
| virtual IEnums::StencilBufferAction | GetBackStencilBufferActionForPassedDepthTest () const =0 |
| Get the back-facing primitive stencil buffer action for passed depth tests. More... | |
| virtual Bool | SetBlendMode (IEnums::BlendMode mode)=0 |
| Set the material's blend mode. More... | |
| virtual IEnums::BlendMode | GetBlendMode () const =0 |
| Get the material's blend mode. More... | |
| virtual Bool | SetBlendFunction (IEnums::BlendFunction srcColorFunction, IEnums::BlendFunction srcAlphaFunction, IEnums::BlendFunction dstColorFunction, IEnums::BlendFunction dstAlphaFunction)=0 |
| Set the material's blending functions. More... | |
| virtual IEnums::BlendFunction | GetSrcColorBlendFunction () const =0 |
| Get the material's blending function used for the source pixels' RGB values. More... | |
| virtual IEnums::BlendFunction | GetSrcAlphaBlendFunction () const =0 |
| Get the material's blending function used for the source pixels' alpha value. More... | |
| virtual IEnums::BlendFunction | GetDstColorBlendFunction () const =0 |
| Get the material's blending function used for the destination pixels' RGB values. More... | |
| virtual IEnums::BlendFunction | GetDstAlphaBlendFunction () const =0 |
| Get the material's blending function used for the destination pixels' alpha value. More... | |
| virtual Bool | SetBlendEquation (IEnums::BlendEquation colorEquation, IEnums::BlendEquation alphaEquation)=0 |
| Set the material's blending equations. More... | |
| virtual IEnums::BlendEquation | GetColorBlendEquation () const =0 |
| Get the material's blending equation for RGB values. More... | |
| virtual IEnums::BlendEquation | GetAlphaBlendEquation () const =0 |
| Get the material's blending equation for alpha values. More... | |
| virtual Bool | SetColorBufferClearingEnabled (Bool enabled)=0 |
| Enable/disable clearing of the render target's color buffer. More... | |
| virtual Bool | IsColorBufferClearingEnabled () const =0 |
| Check if clearing of the render target's color buffer is enabled. More... | |
| virtual Bool | SetDepthBufferClearingEnabled (Bool enabled)=0 |
| Enable/disable clearing of the render target's depth buffer. More... | |
| virtual Bool | IsDepthBufferClearingEnabled () const =0 |
| Check if clearing of the render target's depth buffer is enabled. More... | |
| virtual Bool | SetStencilBufferClearingEnabled (Bool enabled)=0 |
| Enable/disable clearing of the render target's stencil buffer. More... | |
| virtual Bool | IsStencilBufferClearingEnabled () const =0 |
| Check if clearing of the render target's stencil buffer is enabled. More... | |
| virtual Bool | SetColorBufferClearValue (const Color &value)=0 |
| Set the clear color in effect when color buffer clearing is enabled. More... | |
| virtual const Color & | GetColorBufferClearValue () const =0 |
| Get the clear color in effect when color buffer clearing is enabled. More... | |
| virtual Bool | SetDepthBufferClearValue (Real value)=0 |
| Set the clear value in effect when depth buffer clearing is enabled. More... | |
| virtual Real | GetDepthBufferClearValue () const =0 |
| Get the clear value in effect when depth buffer clearing is enabled. More... | |
| virtual Bool | SetStencilBufferClearValue (UInt32 value)=0 |
| Set the clear value in effect when stencil buffer clearing is enabled. More... | |
| virtual UInt32 | GetStencilBufferClearValue () const =0 |
| Get the clear value in effect when stencil buffer clearing is enabled. More... | |
| virtual Bool | SetObjectSortMode (IEnums::ObjectSortMode mode)=0 |
| Set the material's object sorting mode. More... | |
| virtual IEnums::ObjectSortMode | GetObjectSortMode () const =0 |
| Get the material's object sorting mode. More... | |
| virtual Bool | SetSortOrder (SInt32 order)=0 |
| Set the material's sorting order relative to other materials. More... | |
| virtual SInt32 | GetSortOrder () const =0 |
| Get the material's sorting order relative to other materials. More... | |
| virtual Bool | SetVariableDepthOffset (Real offset)=0 |
| Set the variable offset for depth buffer value calculation. More... | |
| virtual Real | GetVariableDepthOffset () const =0 |
| Get the variable offset for depth buffer value calculation. More... | |
| virtual Bool | SetConstantDepthOffset (Real offset)=0 |
| Set the constant offset for depth buffer value calculation. More... | |
| virtual Real | GetConstantDepthOffset () const =0 |
| Get the constant offset for depth buffer value calculation. More... | |
| virtual Bool | SetCameraSlot (SInt32 cameraSlot)=0 |
| Set the material's camera slot. More... | |
| virtual Bool | SetLayerOffset (SInt32 layerOffset)=0 |
| Set the material's layer offset. More... | |
| virtual Bool | SetParametersStage (SInt32 parametersStage)=0 |
| Set the material's parameters pass. More... | |
| virtual Bool | SetTextureStage (UInt32 unit, SInt32 textureStage)=0 |
| Set the material's texture pass for a given unit. More... | |
| virtual Bool | SetLightStageUnit (SInt32 unit)=0 |
| Set the light stage unit used for multi-pass lighting. More... | |
| virtual Bool | SetLightMaskEnabled (Bool enabled)=0 |
| Set if the light should be masked for multi-pass lighting. More... | |
| virtual Bool | SetMinNumberOfLightStages (UInt32 minNumStages)=0 |
| Set the material's minimum number of light stages. More... | |
| virtual Bool | SetMaxNumberOfLightStages (UInt32 maxNumStages)=0 |
| Set the material's maximum number of light stages. More... | |
| virtual Bool | SetDepthMaterial (Bool depthMaterial)=0 |
| Defines if the material can handle only depth passes (no color output available) More... | |
| virtual UInt32 | GetNumberOfDetailLevels () const =0 |
| Get the material's number of detail levels. More... | |
| virtual UInt32 | GetNumberOfStages (UInt32 detailLevel) const =0 |
| Get the material's number of stages for a given detail level. More... | |
| virtual SInt32 | GetCameraSlot (UInt32 detailLevel, UInt32 stage) const =0 |
| Get the material's camera slot for a given stage. More... | |
| virtual SInt32 | GetLayerOffset (UInt32 detailLevel, UInt32 stage) const =0 |
| Get the material's layer offset for a given stage. More... | |
| virtual SInt32 | GetParametersStage (UInt32 detailLevel, UInt32 stage) const =0 |
| Get the material's parameter stage for a given material stage. More... | |
| virtual SInt32 | GetTextureStage (UInt32 detailLevel, UInt32 stage, UInt32 unit) const =0 |
| Get the material's texture stage for a given material stage and texture unit. More... | |
| virtual SInt32 | GetLightStageUnit (UInt32 detailLevel, UInt32 stage) const =0 |
| Get the light stage unit used for multi-stage lighting for a given material stage. More... | |
| virtual Bool | IsLightMaskEnabled (UInt32 detailLevel, UInt32 stage) const =0 |
| Check if the light is masked for multi-pass lighting. More... | |
| virtual UInt32 | GetMinNumberOfLightStages (UInt32 detailLevel, UInt32 stage) const =0 |
| Get the material's minimum number of light stages for a given material stage. More... | |
| virtual UInt32 | GetMaxNumberOfLightStages (UInt32 detailLevel, UInt32 stage) const =0 |
| Get the material's maximum number of light stages for a given material stage. More... | |
| virtual UInt32 | GetNumberOfLightStages (UInt32 detailLevel, UInt32 stage, UInt32 numLights) const =0 |
| Get the material's minimum number of light stages for a given material stage. More... | |
| virtual Video::IMaterial * | GetVideoMaterialObject (UInt32 detailLevel, UInt32 stage) const =0 |
| Get the material's internal video renderer object for a given index. More... | |
| Public Member Functions inherited from Murl::Graph::IStateSlot | |
| virtual Bool | SetSlot (SInt32 slot)=0 |
| Set the slot index to use. More... | |
| virtual SInt32 | GetSlot () const =0 |
| Get the slot index to use. More... | |
Detailed Description
The IUniversalMaterial graph node interface.
Member Function Documentation
◆ GetUniversalProgramNodeTarget() [1/2]
|
pure virtual |
Get the mutable Graph::IUniversalProgramNodeTarget container.
This method returns a mutable pointer to the node's Graph::IUniversalProgramNodeTarget container, which allows to set or query the program object used with this material.
- Returns
- The mutable Graph::IUniversalProgramNodeTarget container, or null if not available.
◆ GetUniversalProgramNodeTarget() [2/2]
|
pure virtual |
Get the constant Graph::IUniversalProgramNodeTarget container.
This method returns a constant pointer to the node's Graph::IUniversalProgramNodeTarget container, which allows to query the program object used with this material.
- Returns
- The mutable Graph::IUniversalProgramNodeTarget container, or null if not available.
The documentation for this interface was generated from the following file:
- murl_graph_i_universal_material.h