CommonStates

The CommonStates class is a static class which defines the most common combinations of Direct3D rendering states.

Related tutorials: Sprites and textures

Header

#include <CommonStates.h>

Usage

Each state provides a D3D12_*_DESC structure which can be used to create a Pipeline State Object (PSO):

D3D12_GRAPHICS_PIPELINE_STATE_DESC psoDesc = {};
psoDesc.RasterizerState = CommonStates::CullNone;
psoDesc.BlendState = CommonStates::Opaque;
psoDesc.DepthStencilState = CommonStates::DepthDefault;
...
DX::ThrowIfFailed(
    device->CreateGraphicsPipelineState(&psoDesc,
        IID_PPV_ARGS(m_pipelineState.ReleaseAndGetAddressOf())));

They are typically used with EffectPipelineStateDescription:

RenderTargetState rtState(m_deviceResources->GetBackBufferFormat(),
    m_deviceResources->GetDepthBufferFormat());

EffectPipelineStateDescription pd(
    &VertexPositionColor::InputLayout,
    &CommonStates::Opaque,
    &CommonStates::DepthDefault,
    &CommonStates::CullNone,
    &rtState);

Blending State

XNA Game Studio

• static const D3D12_BLEND_DESC Opaque;
• static const D3D12_BLEND_DESC AlphaBlend;
• static const D3D12_BLEND_DESC Additive;
• static const D3D12_BLEND_DESC NonPremultiplied;

Typical usage

For standard drawing, typically you should make use of Opaque.

For drawing alpha-blended objects, you should use AlphaBlend if using premultiplied alpha, or NonPremultiplied if using 'straight' alpha.

For multipass rendering, you'd typically use Additive.

Depth/Stencil State

XNA Game Studio

• static const D3D12_DEPTH_STENCIL_DESC DepthNone;
• static const D3D12_DEPTH_STENCIL_DESC DepthDefault;
• static const D3D12_DEPTH_STENCIL_DESC DepthRead;

Typical usage

For standard rendering with a z-buffer, you should use DepthDefault.

For drawing alpha blended objects (which is typically done after all opaque objects have been drawn), use DepthRead which will respect the existing z-buffer values, but will not update them with 'closer' pixels.

For drawing objects without any depth-sort at all, use DepthNone.

Rasterizer State

XNA Game Studio

• static const D3D12_RASTERIZER_DESC CullNone;
• static const D3D12_RASTERIZER_DESC CullClockwise;
• static const D3D12_RASTERIZER_DESC CullCounterClockwise;
• static const D3D12_RASTERIZER_DESC Wireframe;

Typical usage

For default geometry winding use CullCounterClockwise. For inverted winding (typically when using assets designed for left-handed coordinates but rendering with right-handed coordinates or vice-versa), use CullClockwise.

For "double-sided" geometry, use CullNone. Keep in mind this is a potentially large performance hit, so use it sparingly.

Wireframe is a wireframe rendering mode and shows both sides of the geometry.

Sampler State

XNA Game Studio

• static const D3D12_SAMPLER_DESC PointWrap;
• static const D3D12_SAMPLER_DESC PointClamp;
• static const D3D12_SAMPLER_DESC LinearWrap;
• static const D3D12_SAMPLER_DESC LinearClamp;
• static const D3D12_SAMPLER_DESC AnisotropicWrap;
• static const D3D12_SAMPLER_DESC AnisotropicClamp;

Typical usage

AnisotropicWrap is the default sampler settings for DirectX 12 and the built-in effects.

Further reading

State objects in XNA Game Studio 4.0

Premultiplied Alpha