C++ API Reference
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
MRasterizerStateDesc Class Reference
OpenMayaRender - API module for rendering

Descriptor for a complete rasterizer state. More...

#include <MStateManager.h>

Public Member Functions

 MRasterizerStateDesc ()
 Constructor, builds a default rasterizer state.
 
 ~MRasterizerStateDesc ()
 Destructor.
 
void setDefaults ()
 Set all values for the rasterizer state to their default values.
 
 MRasterizerStateDesc (const MRasterizerStateDesc &rDesc)
 NO SCRIPT SUPPORT. More...
 
MRasterizerStateDesc & operator= (const MRasterizerStateDesc &rDesc)
 NO SCRIPT SUPPORT. More...
 

Static Public Member Functions

static const char * className ()
 Returns the name of this class. More...
 

Public Attributes

MRasterizerState::FillMode fillMode
 Select the primitive fill mode, default kFillSolid. More...
 
MRasterizerState::CullMode cullMode
 Select the face culling mode, default kCullNone. More...
 
bool frontCounterClockwise
 Select whether CW or CCW winding is used for "front" face, default false. More...
 
bool depthBiasIsFloat
 Indicates that DepthBias is a float value, default false. More...
 
float depthBias
 DepthBias adds the given bias value to the rasterizer z value prior to depth testing. More...
 
float depthBiasClamp
 Maximum value scaled depth bias can attain, default 0. More...
 
float slopeScaledDepthBias
 Slope scaled depth bias value, default 0. More...
 
bool depthClipEnable
 Enables HW automatic depth clipping, default true. More...
 
bool scissorEnable
 Enables HW scissor clip rectangle, default false. More...
 
bool multiSampleEnable
 Enables HW full screen multi-sample anti-aliasing, default false. More...
 
bool antialiasedLineEnable
 Enables HW anti-aliased lines, auto disabled by multi-sample AA, default false. More...
 

Detailed Description

Descriptor for a complete rasterizer state.

This class describes a complete rasterizer state, like fill mode, cull mode, depth bias, multisampling, point size, etc.

Examples:
cgFx/cgfxPassStateSetter.cpp, gpuCache/gpuCacheDrawOverride.cpp, rawfootPrintNode/rawfootPrintNode.cpp, and viewDX11DeviceAccess/viewDX11DeviceAccess.cpp.

Constructor & Destructor Documentation

MRasterizerStateDesc ( const MRasterizerStateDesc &  rDesc)

NO SCRIPT SUPPORT.

Copy constructor.

Parameters
[in]rDescThe descriptor to copy

Member Function Documentation

MRasterizerStateDesc & operator= ( const MRasterizerStateDesc &  rDesc)

NO SCRIPT SUPPORT.

Assignment operator.

Parameters
[in]rDescThe descriptor to copy
Returns
Reference to this descriptor
const char * className ( )
static

Returns the name of this class.

Returns
Name of this class.

Member Data Documentation

MRasterizerState::FillMode fillMode

Select the primitive fill mode, default kFillSolid.

Examples:
cgFx/cgfxPassStateSetter.cpp, and viewDX11DeviceAccess/viewDX11DeviceAccess.cpp.
MRasterizerState::CullMode cullMode

Select the face culling mode, default kCullNone.

Examples:
cgFx/cgfxPassStateSetter.cpp, gpuCache/gpuCacheDrawOverride.cpp, and viewDX11DeviceAccess/viewDX11DeviceAccess.cpp.
bool frontCounterClockwise

Select whether CW or CCW winding is used for "front" face, default false.

Examples:
cgFx/cgfxPassStateSetter.cpp, and viewDX11DeviceAccess/viewDX11DeviceAccess.cpp.
bool depthBiasIsFloat

Indicates that DepthBias is a float value, default false.

Examples:
cgFx/cgfxPassStateSetter.cpp, gpuCache/gpuCacheDrawOverride.cpp, and viewDX11DeviceAccess/viewDX11DeviceAccess.cpp.
float depthBias

DepthBias adds the given bias value to the rasterizer z value prior to depth testing.

Examples:
cgFx/cgfxPassStateSetter.cpp, gpuCache/gpuCacheDrawOverride.cpp, and viewDX11DeviceAccess/viewDX11DeviceAccess.cpp.
float depthBiasClamp

Maximum value scaled depth bias can attain, default 0.

Examples:
viewDX11DeviceAccess/viewDX11DeviceAccess.cpp.
float slopeScaledDepthBias

Slope scaled depth bias value, default 0.

Examples:
cgFx/cgfxPassStateSetter.cpp, gpuCache/gpuCacheDrawOverride.cpp, and viewDX11DeviceAccess/viewDX11DeviceAccess.cpp.
bool depthClipEnable

Enables HW automatic depth clipping, default true.

Examples:
cgFx/cgfxPassStateSetter.cpp, and viewDX11DeviceAccess/viewDX11DeviceAccess.cpp.
bool scissorEnable

Enables HW scissor clip rectangle, default false.

Examples:
cgFx/cgfxPassStateSetter.cpp, and viewDX11DeviceAccess/viewDX11DeviceAccess.cpp.
bool multiSampleEnable

Enables HW full screen multi-sample anti-aliasing, default false.

Examples:
cgFx/cgfxPassStateSetter.cpp, and viewDX11DeviceAccess/viewDX11DeviceAccess.cpp.
bool antialiasedLineEnable

Enables HW anti-aliased lines, auto disabled by multi-sample AA, default false.

Examples:
cgFx/cgfxPassStateSetter.cpp, and viewDX11DeviceAccess/viewDX11DeviceAccess.cpp.
The documentation for this class was generated from the following files: