This reference page is linked to from the following overview topics: Nitrous Graphics SDK Extensions.
#include <RenderStates.h>
This class holds the blend state for single render target.
Public Member Functions |
|
virtual void | SetBlendEnabled (bool value) |
Set the blending is enabled or not. |
|
virtual bool | GetBlendEnabled () const |
Get the blending is enabled or not. |
|
virtual void | SetSourceBlend (BlendSelector value) |
Set the blend factor for source color.
|
|
virtual BlendSelector | GetSourceBlend () const |
Set the blend factor for source color.
|
|
virtual void | SetDestinationBlend (BlendSelector value) |
Set the blend factor for destination color.
|
|
virtual BlendSelector | GetDestinationBlend () const |
Get the blend factor for destination color
/return current destination blend factor. |
|
virtual void | SetColorBlendOperation (BlendOperation value) |
Set the operation for color blending.
|
|
virtual BlendOperation | GetColorBlendOperation () const |
Get the operation for color blending.
|
|
virtual void | SetAlphaSourceBlend (BlendSelector value) |
Set the blend factor for source alpha.
|
|
virtual BlendSelector | GetAlphaSourceBlend () const |
Get the blend factor for source alpha.
|
|
virtual void | SetAlphaDestinationBlend (BlendSelector value) |
Set the blend factor for destination alpha.
|
|
virtual BlendSelector | GetAlphaDestinationBlend () const |
Get the blend factor for destination alpha.
|
|
virtual void | SetAlphaBlendOperation (BlendOperation value) |
Set the operation for alpha blending.
|
|
virtual BlendOperation | GetAlphaBlendOperation () const |
Get the operation for alpha blending.
|
|
virtual void | SetRenderTargetWriteMask (ColorWriteEnable mask) |
Indicates what color components(red, green,
blue, alpha) are writable. |
|
virtual ColorWriteEnable | GetRenderTargetWriteMask () const |
Get color write mask /return current mask.
|
|
Protected Member Functions |
|
TargetBlendState () | |
virtual | ~TargetBlendState () |
Protected Attributes |
|
bool | mBlendEnabled |
The blending is enabled or not. |
|
BlendSelector | mSourceBlend |
The blend factor for source color. |
|
BlendSelector | mDestinationBlend |
The blend factor for destination color.
|
|
BlendOperation | mColorBlendOperation |
The operation for color blending. |
|
BlendSelector | mAlphaSourceBlend |
The blend factor for source alpha. |
|
BlendSelector | mAlphaDestinationBlend |
The blend factor for destination alpha.
|
|
BlendOperation | mAlphaBlendOperation |
The operation for alpha blending. |
|
ColorWriteEnable | mRenderTargetWriteMask |
Indicates what color components(red, green,
blue, alpha) are writable. |
|
Friends |
|
class | BlendState |
TargetBlendState | ( | ) | [protected] |
virtual ~TargetBlendState | ( | ) | [inline, protected, virtual] |
{}
virtual void SetBlendEnabled | ( | bool | value | ) | [virtual] |
Set the blending is enabled or not.
Default value is false. /param value true to enable blending, false to disable
virtual bool GetBlendEnabled | ( | ) | const [virtual] |
Get the blending is enabled or not.
/return true if enabled, false if not.
virtual void SetSourceBlend | ( | BlendSelector | value | ) | [virtual] |
Set the blend factor for source color.
Default value is BlendSelectorOne. /param value source blend factor
virtual BlendSelector GetSourceBlend | ( | ) | const [virtual] |
Set the blend factor for source color.
/return current source blend factor
virtual void SetDestinationBlend | ( | BlendSelector | value | ) | [virtual] |
Set the blend factor for destination color.
Default value is BlendSelectorZero. /param value destination blend factor
virtual BlendSelector GetDestinationBlend | ( | ) | const [virtual] |
Get the blend factor for destination color /return current destination blend factor.
virtual void SetColorBlendOperation | ( | BlendOperation | value | ) | [virtual] |
Set the operation for color blending.
Default value is BlendOperationAdd. /param value the operation for color blending
virtual BlendOperation GetColorBlendOperation | ( | ) | const [virtual] |
Get the operation for color blending.
/return the operation for color blending.
virtual void SetAlphaSourceBlend | ( | BlendSelector | value | ) | [virtual] |
Set the blend factor for source alpha.
Default value is BlendSelectorOne. /param value the blend factor for source alpha
virtual BlendSelector GetAlphaSourceBlend | ( | ) | const [virtual] |
Get the blend factor for source alpha.
/return the blend factor for source alpha
virtual void SetAlphaDestinationBlend | ( | BlendSelector | value | ) | [virtual] |
Set the blend factor for destination alpha.
Default value is BlendSelectorZero. /param value blend factor for destination alpha
virtual BlendSelector GetAlphaDestinationBlend | ( | ) | const [virtual] |
Get the blend factor for destination alpha.
/return the blend factor for destination alpha.
virtual void SetAlphaBlendOperation | ( | BlendOperation | value | ) | [virtual] |
Set the operation for alpha blending.
Default value is BlendOperationAdd. /param value the operation for alpha blending
virtual BlendOperation GetAlphaBlendOperation | ( | ) | const [virtual] |
Get the operation for alpha blending.
/return the operation for alpha blending.
virtual void SetRenderTargetWriteMask | ( | ColorWriteEnable | mask | ) | [virtual] |
Indicates what color components(red, green, blue, alpha) are writable.
Default value is ColorWriteEnableRedGreenBlueAlpha. /param mask the write mask
virtual ColorWriteEnable GetRenderTargetWriteMask | ( | ) | const [virtual] |
Get color write mask /return current mask.
friend class BlendState
[friend] |
bool
mBlendEnabled [protected] |
BlendSelector
mSourceBlend [protected] |
BlendSelector
mDestinationBlend [protected] |
The blend factor for destination color.
By default it is BlendSelectorZero.
BlendOperation
mColorBlendOperation [protected] |
BlendSelector
mAlphaSourceBlend [protected] |
BlendSelector
mAlphaDestinationBlend [protected] |
The blend factor for destination alpha.
By default it is BlendSelectorZero.
BlendOperation
mAlphaBlendOperation [protected] |
ColorWriteEnable
mRenderTargetWriteMask [protected] |
Indicates what color components(red, green, blue, alpha) are writable.
By default it is ColorWriteEnableRedGreenBlueAlpha.