Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

CD3DX12_DEPTH_STENCIL_DESC structure

A helper structure to enable easy initialization of a D3D12_DEPTH_STENCIL_DESC structure.

Syntax

struct CD3DX12_DEPTH_STENCIL_DESC : public D3D12_DEPTH_STENCIL_DESC{
 CD3DX12_DEPTH_STENCIL_DESC();
 explicit CD3DX12_DEPTH_STENCIL_DESC(const D3D12_DEPTH_STENCIL_DESC& o);
 explicit CD3DX12_DEPTH_STENCIL_DESC(CD3DX12_DEFAULT);
 explicit CD3DX12_DEPTH_STENCIL_DESC(BOOL depthEnable, D3D12_DEPTH_WRITE_MASK depthWriteMask, D3D12_COMPARISON_FUNC depthFunc, BOOL stencilEnable, UINT8 stencilReadMask, UINT8 stencilWriteMask, D3D12_STENCIL_OP frontStencilFailOp, D3D12_STENCIL_OP frontStencilDepthFailOp, D3D12_STENCIL_OP frontStencilPassOp, D3D12_COMPARISON_FUNC frontStencilFunc, D3D12_STENCIL_OP backStencilFailOp, D3D12_STENCIL_OP backStencilDepthFailOp, D3D12_STENCIL_OP backStencilPassOp, D3D12_COMPARISON_FUNC backStencilFunc);
 ~CD3DX12_DEPTH_STENCIL_DESC();
 operator const D3D12_DEPTH_STENCIL_DESC&() const;
};

Members

CD3DX12_DEPTH_STENCIL_DESC()

Creates a new, uninitialized, instance of a D3DX12_DEPTH_STENCIL_DESC.

explicit CD3DX12_DEPTH_STENCIL_DESC(const D3D12_DEPTH_STENCIL_DESC& o)

Creates a new instance of a D3DX12_DEPTH_STENCIL_DESC, initialized with the contents of another D3D12_DEPTH_STENCIL_DESC structure.

explicit CD3DX12_DEPTH_STENCIL_DESC(CD3DX12_DEFAULT)

Creates a new instance of a D3DX12_DEPTH_STENCIL_DESC, initialized with default parameters.

 DepthEnable = TRUE; 
 DepthWriteMask = D3D12_DEPTH_WRITE_MASK_ALL; 
 DepthFunc = D3D12_COMPARISON_FUNC_LESS; 
 StencilEnable = FALSE; 
 StencilReadMask = D3D12_DEFAULT_STENCIL_READ_MASK; 
 StencilWriteMask = D3D12_DEFAULT_STENCIL_WRITE_MASK; 
 const D3D12_DEPTH_STENCILOP_DESC defaultStencilOp = 
 { D3D12_STENCIL_OP_KEEP, D3D12_STENCIL_OP_KEEP, D3D12_STENCIL_OP_KEEP, D3D12_COMPARISON_FUNC_ALWAYS }; 
 FrontFace = defaultStencilOp; 
 BackFace = defaultStencilOp; 

explicit CD3DX12_DEPTH_STENCIL_DESC(BOOL depthEnable, D3D12_DEPTH_WRITE_MASK depthWriteMask, D3D12_COMPARISON_FUNC depthFunc, BOOL stencilEnable, UINT8 stencilReadMask, UINT8 stencilWriteMask, D3D12_STENCIL_OP frontStencilFailOp, D3D12_STENCIL_OP frontStencilDepthFailOp, D3D12_STENCIL_OP frontStencilPassOp, D3D12_COMPARISON_FUNC frontStencilFunc, D3D12_STENCIL_OP backStencilFailOp, D3D12_STENCIL_OP backStencilDepthFailOp, D3D12_STENCIL_OP backStencilPassOp, D3D12_COMPARISON_FUNC backStencilFunc)

Creates a new instance of a D3DX12_DEPTH_STENCIL_DESC, initializing the following parameters:

BOOL depthEnable

D3D12_DEPTH_WRITE_MASK depthWriteMask

D3D12_COMPARISON_FUNC depthFunc

BOOL stencilEnable

UINT8 stencilReadMask

UINT8 stencilWriteMask

D3D12_STENCIL_OP frontStencilFailOp

D3D12_STENCIL_OP frontStencilDepthFailOp

D3D12_STENCIL_OP frontStencilPassOp

D3D12_COMPARISON_FUNC frontStencilFunc

D3D12_STENCIL_OP backStencilFailOp

D3D12_STENCIL_OP backStencilDepthFailOp

D3D12_STENCIL_OP backStencilPassOp

D3D12_COMPARISON_FUNC backStencilFunc

~CD3DX12_DEPTH_STENCIL_DESC()

Destroys an instance of a CD3DX12_DEPTH_STENCIL_DESC.

operator const D3D12_DEPTH_STENCIL_DESC&() const

Defines the & pass-by-reference operator for the parent structure type.

Requirements

Requirement Value
Header
D3dx12.h

See also

D3D12_DEPTH_STENCIL_DESC

Helper Structures for D3D12


Feedback

Was this page helpful?

Additional resources