FExclusiveDepthStencil Class Reference

#include <RHIResources.h>

Public Types
enum	Type {   DepthNop = 0x00 , DepthRead = 0x01 , DepthWrite = 0x02 , DepthMask = 0x0f ,   StencilNop = 0x00 , StencilRead = 0x10 , StencilWrite = 0x20 , StencilMask = 0xf0 ,   DepthNop_StencilNop = DepthNop + StencilNop , DepthRead_StencilNop = DepthRead + StencilNop , DepthWrite_StencilNop = DepthWrite + StencilNop , DepthNop_StencilRead = DepthNop + StencilRead ,   DepthRead_StencilRead = DepthRead + StencilRead , DepthWrite_StencilRead = DepthWrite + StencilRead , DepthNop_StencilWrite = DepthNop + StencilWrite , DepthRead_StencilWrite = DepthRead + StencilWrite ,   DepthWrite_StencilWrite = DepthWrite + StencilWrite }

Public Member Functions
	FExclusiveDepthStencil (Type InValue=DepthNop_StencilNop)
bool	IsUsingDepthStencil () const
bool	IsUsingDepth () const
bool	IsUsingStencil () const
bool	IsDepthWrite () const
bool	IsDepthRead () const
bool	IsStencilWrite () const
bool	IsStencilRead () const
bool	IsAnyWrite () const
void	SetDepthWrite ()
void	SetStencilWrite ()
void	SetDepthStencilWrite (bool bDepth, bool bStencil)
bool	operator== (const FExclusiveDepthStencil &rhs) const
bool	operator!= (const FExclusiveDepthStencil &RHS) const
bool	IsValid (FExclusiveDepthStencil &Current) const
void	GetAccess (ERHIAccess &DepthAccess, ERHIAccess &StencilAccess) const
template<typename TFunction >
void	EnumerateSubresources (TFunction Function) const
FExclusiveDepthStencil	GetReadableTransition () const
FExclusiveDepthStencil	GetWritableTransition () const
uint32	GetIndex () const

Static Public Attributes
static const uint32	MaxIndex = 4

Friends
uint32	GetTypeHash (const FExclusiveDepthStencil &Ds)

Member Enumeration Documentation

Type

enum FExclusiveDepthStencil::Type

Enumerator
DepthNop
DepthRead
DepthWrite
DepthMask
StencilNop
StencilRead
StencilWrite
StencilMask
DepthNop_StencilNop
DepthRead_StencilNop
DepthWrite_StencilNop
DepthNop_StencilRead
DepthRead_StencilRead
DepthWrite_StencilRead
DepthNop_StencilWrite
DepthRead_StencilWrite
DepthWrite_StencilWrite

Constructor & Destructor Documentation

FExclusiveDepthStencil()

FExclusiveDepthStencil::FExclusiveDepthStencil ( Type  InValue = DepthNop_StencilNop )

inline

Member Function Documentation

EnumerateSubresources()

template<typename TFunction >

void FExclusiveDepthStencil::EnumerateSubresources ( TFunction  Function ) const

inline

GetAccess()

void FExclusiveDepthStencil::GetAccess ( ERHIAccess &  DepthAccess, ERHIAccess &  StencilAccess  ) const

inline

GetIndex()

uint32 FExclusiveDepthStencil::GetIndex ( ) const

inline

GetReadableTransition()

FExclusiveDepthStencil FExclusiveDepthStencil::GetReadableTransition ( ) const

inline

Returns a new FExclusiveDepthStencil to be used to transition a depth stencil resource to readable. If the depth or stencil is already in a readable state, that particular component is returned as Nop, to avoid unnecessary subresource transitions.

GetWritableTransition()

FExclusiveDepthStencil FExclusiveDepthStencil::GetWritableTransition ( ) const

inline

Returns a new FExclusiveDepthStencil to be used to transition a depth stencil resource to readable. If the depth or stencil is already in a readable state, that particular component is returned as Nop, to avoid unnecessary subresource transitions.

IsAnyWrite()

bool FExclusiveDepthStencil::IsAnyWrite ( ) const

inline

IsDepthRead()

bool FExclusiveDepthStencil::IsDepthRead ( ) const

inline

IsDepthWrite()

bool FExclusiveDepthStencil::IsDepthWrite ( ) const

inline

IsStencilRead()

bool FExclusiveDepthStencil::IsStencilRead ( ) const

inline

IsStencilWrite()

bool FExclusiveDepthStencil::IsStencilWrite ( ) const

inline

IsUsingDepth()

bool FExclusiveDepthStencil::IsUsingDepth ( ) const

inline

IsUsingDepthStencil()

bool FExclusiveDepthStencil::IsUsingDepthStencil ( ) const

inline

IsUsingStencil()

bool FExclusiveDepthStencil::IsUsingStencil ( ) const

inline

IsValid()

bool FExclusiveDepthStencil::IsValid ( FExclusiveDepthStencil &  Current ) const

inline

operator!=()

bool FExclusiveDepthStencil::operator!= ( const FExclusiveDepthStencil &  RHS ) const

inline

operator==()

bool FExclusiveDepthStencil::operator== ( const FExclusiveDepthStencil &  rhs ) const

inline

SetDepthStencilWrite()

void FExclusiveDepthStencil::SetDepthStencilWrite ( bool  bDepth, bool  bStencil  )

inline

SetDepthWrite()

void FExclusiveDepthStencil::SetDepthWrite ( )

inline

SetStencilWrite()

void FExclusiveDepthStencil::SetStencilWrite ( )

inline

Friends And Related Symbol Documentation

GetTypeHash

uint32 GetTypeHash ( const FExclusiveDepthStencil &  Ds )

friend

Member Data Documentation

MaxIndex

const uint32 FExclusiveDepthStencil::MaxIndex = 4

static

---

The documentation for this class was generated from the following file:

• Engine/Source/Runtime/RHI/Public/RHIResources.h