BlendState Class Reference
 
 
 
BlendState Class Reference

This reference page is linked to from the following overview topics: Nitrous Graphics SDK Extensions.


#include <RenderStates.h>

Inheritance diagram for BlendState:
MaxHeapOperators

Class Description

This class holds the blend state for all render targets.

Public Member Functions

  BlendState ()
virtual  ~BlendState ()
virtual void  SetAlphaToCoverageEnabled (bool value)
  Set the AlphaToCoverage state.
virtual bool  GetAlphaToCoverageEnabled () const
  Get the AlphaToCoverage state.
virtual void  SetIndependentBlendEnabled (bool value)
  Set independent blend state If independent blend is enabled, each target has its own blend state; Otherwise all targets share one blend state.
virtual bool  GetIndependentBlendEnabled () const
  Get independent blend state /return true if independent blend is enabled, false if not.
virtual void  SetBlendFactor (Point4 &factor)
  Set the color blending factor.
virtual Point4  GetBlendFactor () const
  Get the color blending factor.
virtual void  SetMultiSampleMask (unsigned int mask)
  Set multi-sample mask.
virtual unsigned int  GetMultiSampleMask () const
  Get multi-sample mask /return the mask.
virtual TargetBlendState GetTargetBlendState (size_t index)
  Get individual target blend state.

Protected Attributes

bool  mAlphaToCoverageEnabled
  The AlphaToCoverage state Note: "AlphaToCoverage" is only valid for multi-sampling.
bool  mIndependentBlendEnabled
  Independent blend state If independent blend is enabled, each target has its own blend state; Otherwise all targets share one blend state.
Point4  mBlendFactor
  The color blending factor.
unsigned int  mMultiSampleMask
  Multisample mask Default value is 0xffffffff.
TargetBlendState  mBlendStates [MAX_TARGETS_SLOT]

Constructor & Destructor Documentation

virtual ~BlendState ( ) [inline, virtual]
{}

Member Function Documentation

virtual void SetAlphaToCoverageEnabled ( bool  value ) [virtual]

Set the AlphaToCoverage state.

Default value is false Note: "AlphaToCoverage" is only valid for multi-sampling. /param value true to enable alpha-to-coverage, false to disable.

virtual bool GetAlphaToCoverageEnabled ( ) const [virtual]

Get the AlphaToCoverage state.

return true if alpha-to-coverage is enabled, false if not

virtual void SetIndependentBlendEnabled ( bool  value ) [virtual]

Set independent blend state If independent blend is enabled, each target has its own blend state; Otherwise all targets share one blend state.

Default value is false /param value true to enable independent blend, false to disable

virtual bool GetIndependentBlendEnabled ( ) const [virtual]

Get independent blend state /return true if independent blend is enabled, false if not.

virtual void SetBlendFactor ( Point4 factor ) [virtual]

Set the color blending factor.

Default value is Point4(1.0f, 1.0f , 1.0f, 1.0f); /param factor color blending factor

virtual Point4 GetBlendFactor ( ) const [virtual]

Get the color blending factor.

/return the factor

virtual void SetMultiSampleMask ( unsigned int  mask ) [virtual]

Set multi-sample mask.

Default value is 0xffffffff /param value the mask

virtual unsigned int GetMultiSampleMask ( ) const [virtual]

Get multi-sample mask /return the mask.

virtual TargetBlendState& GetTargetBlendState ( size_t  index ) [virtual]

Get individual target blend state.

/param index index of the target. Max value is MAX_TARGETS_SLOT. /return target blend state handle


Member Data Documentation

bool mAlphaToCoverageEnabled [protected]

The AlphaToCoverage state Note: "AlphaToCoverage" is only valid for multi-sampling.

Default value is false

bool mIndependentBlendEnabled [protected]

Independent blend state If independent blend is enabled, each target has its own blend state; Otherwise all targets share one blend state.

Default value is false

Point4 mBlendFactor [protected]

The color blending factor.

unsigned int mMultiSampleMask [protected]

Multisample mask Default value is 0xffffffff.