Standard Parameter flags

Standard Parameter flags

Module description

Standard parameter flags for shaders.

A combination of these flags is returned by Shader::SupportStdParams()

Macros

#define STD_PARAM_NONE   (0)
 Indicates that none of the flags in the Standard_Parameters is used. More...
 
#define STD_PARAM_ALL   (0xffffffffL)
 Indicates that all of the flags in the Standard_Parameters are used. More...
 
#define STD_PARAM_METAL   (1)
 Only used by the Metal shader. More...
 
#define STD_PARAM_LOCKDS   (1<<1)
 Indicates support for the Diffuse/Specular lock. More...
 
#define STD_PARAM_LOCKAD   (1<<2)
 Indicates support for the Ambient/Diffuse lock. More...
 
#define STD_PARAM_LOCKADTEX   (1<<3)
 Indicates support for the Ambient/Diffuse texture lock. More...
 
#define STD_PARAM_SELFILLUM   (1<<4)
 Indicates support for the Self Illumination parameter. More...
 
#define STD_PARAM_SELFILLUM_CLR   (1<<5)
 Indicates support for the Self Illumination color parameter. More...
 
#define STD_PARAM_AMBIENT_CLR   (1<<6)
 Indicates support for the Ambient color parameter. More...
 
#define STD_PARAM_DIFFUSE_CLR   (1<<7)
 Indicates support for the Diffuse color parameter. More...
 
#define STD_PARAM_SPECULAR_CLR   (1<<8)
 Indicates support for the Specular color parameter. More...
 
#define STD_PARAM_FILTER_CLR   (1<<9)
 Indicates support for the Filter color parameter. More...
 
#define STD_PARAM_GLOSSINESS   (1<<10)
 Indicates support for the Glossiness parameter. More...
 
#define STD_PARAM_SOFTEN_LEV   (1<<11)
 Indicates support for the Soften Level parameter. More...
 
#define STD_PARAM_SPECULAR_LEV   (1<<12)
 Indicates support for the Specular Level parameter. More...
 
#define STD_PARAM_DIFFUSE_LEV   (1<<13)
 Indicates support for the Diffuse Level parameter. More...
 
#define STD_PARAM_DIFFUSE_RHO   (1<<14)
 Indicates support for the Roughness parameter. More...
 
#define STD_PARAM_ANISO   (1<<15)
 Indicates support for the Specular Highlight Anisotropy parameter. More...
 
#define STD_PARAM_ORIENTATION   (1<<16)
 Indicates support for the Specular Highlight Orientation parameter. More...
 
#define STD_PARAM_REFL_LEV   (1<<17)
 This is reserved for future use. More...
 
#define STD_PARAM_SELFILLUM_CLR_ON   (1<<18)
 Indicates support for the Self Illumination Color On/Off checkbox. More...
 
#define STD_BASIC2_DLG   (1<<20)
 This bit is only set by the three pre-R3 shaders (Phong, Blinn, and Metal). More...
 
#define STD_EXTRA_DLG   (1<<21)
 Indicates support for the Extended Parameters rollout. More...
 
#define STD_EXTRA_REFLECTION   (1<<22)
 Indicates support for Reflection Dimming parameters (Apply, Dim Level, Refl Level). More...
 
#define STD_EXTRA_REFRACTION   (1<<23)
 Indicates support for Index of Refraction parameter. More...
 
#define STD_EXTRA_OPACITY   (1<<24)
 Indicates support for Opacity parameters (Amount, In/Out, Type). More...
 

Macro Definition Documentation

#define STD_PARAM_NONE   (0)

Indicates that none of the flags in the Standard_Parameters is used.

#define STD_PARAM_ALL   (0xffffffffL)

Indicates that all of the flags in the Standard_Parameters are used.

#define STD_PARAM_METAL   (1)

Only used by the Metal shader.

#define STD_PARAM_LOCKDS   (1<<1)

Indicates support for the Diffuse/Specular lock.

#define STD_PARAM_LOCKAD   (1<<2)

Indicates support for the Ambient/Diffuse lock.

#define STD_PARAM_LOCKADTEX   (1<<3)

Indicates support for the Ambient/Diffuse texture lock.

#define STD_PARAM_SELFILLUM   (1<<4)

Indicates support for the Self Illumination parameter.

#define STD_PARAM_SELFILLUM_CLR   (1<<5)

Indicates support for the Self Illumination color parameter.

#define STD_PARAM_AMBIENT_CLR   (1<<6)

Indicates support for the Ambient color parameter.

#define STD_PARAM_DIFFUSE_CLR   (1<<7)

Indicates support for the Diffuse color parameter.

#define STD_PARAM_SPECULAR_CLR   (1<<8)

Indicates support for the Specular color parameter.

#define STD_PARAM_FILTER_CLR   (1<<9)

Indicates support for the Filter color parameter.

#define STD_PARAM_GLOSSINESS   (1<<10)

Indicates support for the Glossiness parameter.

#define STD_PARAM_SOFTEN_LEV   (1<<11)

Indicates support for the Soften Level parameter.

#define STD_PARAM_SPECULAR_LEV   (1<<12)

Indicates support for the Specular Level parameter.

#define STD_PARAM_DIFFUSE_LEV   (1<<13)

Indicates support for the Diffuse Level parameter.

#define STD_PARAM_DIFFUSE_RHO   (1<<14)

Indicates support for the Roughness parameter.

#define STD_PARAM_ANISO   (1<<15)

Indicates support for the Specular Highlight Anisotropy parameter.

#define STD_PARAM_ORIENTATION   (1<<16)

Indicates support for the Specular Highlight Orientation parameter.

#define STD_PARAM_REFL_LEV   (1<<17)

This is reserved for future use.

#define STD_PARAM_SELFILLUM_CLR_ON   (1<<18)

Indicates support for the Self Illumination Color On/Off checkbox.

#define STD_BASIC2_DLG   (1<<20)

This bit is only set by the three pre-R3 shaders (Phong, Blinn, and Metal).

If this bit is not set then the Basic Parameters dialog is replaced by the one provided by the plug-in shader.

#define STD_EXTRA_DLG   (1<<21)

Indicates support for the Extended Parameters rollout.

If this bit is not set one provided by the plug-in shader will be used instead. The following three flags, when set, enable the specified controls in the Extended Parameters rollout.

#define STD_EXTRA_REFLECTION   (1<<22)

Indicates support for Reflection Dimming parameters (Apply, Dim Level, Refl Level).

Not including this in the param string disables the relevant params in extra params dialog.

#define STD_EXTRA_REFRACTION   (1<<23)

Indicates support for Index of Refraction parameter.

Not including this in the param string disables the relevant params in extra params dialog.

#define STD_EXTRA_OPACITY   (1<<24)

Indicates support for Opacity parameters (Amount, In/Out, Type).

Not including this in the param string disables the relevant params in extra params dialog.