RHITexture Class Reference

RHI Texture primitive. More...

#include <RHITexture.hpp>

Inheritance diagram for RHITexture:

Collaboration diagram for RHITexture:

Public Member Functions
BRK_API	~RHITexture () override=default
const StringName &	GetName () const
uint32	GetWidth () const
uint32	GetHeight () const
uint32	GetDepth () const
uint32	GetMipsCount () const
uint32	GetArraySlices () const
RHITextureType	GetTextureType () const
RHITextureFormat	GetTextureFormat () const
Mask< RHITextureUsage >	GetTextureUsage () const
bool	UsageShaderSampling () const
bool	UsageColorAttachment () const
bool	UsageDepthStencilAttachment () const
const RHITextureDesc &	GetDesc () const
Public Member Functions inherited from RHIResource
BRK_API	~RHIResource () override=default
Public Member Functions inherited from RefCnt
virtual	~RefCnt ()
bool	IsUnique () const
std::int32_t	GetRefs () const
std::int32_t	AddRef () const
std::int32_t	RelRef () const

Protected Attributes
RHITextureDesc	mDesc

Additional Inherited Members
Protected Member Functions inherited from RHIResource
void	Destroy () const override

Detailed Description

RHI Texture primitive.

Constructor & Destructor Documentation

~RHITexture()

BRK_API RHITexture::~RHITexture ( )

overridedefault

Member Function Documentation

GetArraySlices()

uint32 RHITexture::GetArraySlices ( ) const

inline

Returns

Texture array slices (more actual for array textures)

GetDepth()

uint32 RHITexture::GetDepth ( ) const

inline

Returns

Texture depth in pixels

GetDesc()

const RHITextureDesc& RHITexture::GetDesc ( ) const

inline

Returns

Texture desc

GetHeight()

uint32 RHITexture::GetHeight ( ) const

inline

Returns

Texture height in pixels

GetMipsCount()

uint32 RHITexture::GetMipsCount ( ) const

inline

Returns

Texture mip-maps count

GetName()

const StringName& RHITexture::GetName ( ) const

inline

Returns

Debug texture name (vk profiling tools)

GetTextureFormat()

RHITextureFormat RHITexture::GetTextureFormat ( ) const

inline

Returns

Texture internal storage format

GetTextureType()

RHITextureType RHITexture::GetTextureType ( ) const

inline

Returns

Texture type

GetTextureUsage()

Mask<RHITextureUsage> RHITexture::GetTextureUsage ( ) const

inline

Returns

Texture usage flags

GetWidth()

uint32 RHITexture::GetWidth ( ) const

inline

Returns

Texture width in pixels

UsageColorAttachment()

bool RHITexture::UsageColorAttachment ( ) const

inline

Returns

True if can use as color attachment

UsageDepthStencilAttachment()

bool RHITexture::UsageDepthStencilAttachment ( ) const

inline

Returns

True if can use as depth/stencil attachment

UsageShaderSampling()

bool RHITexture::UsageShaderSampling ( ) const

inline

Returns

True if can use for sampling within shaders

Member Data Documentation

mDesc

RHITextureDesc RHITexture::mDesc

protected

Texture desc

---

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

• code/runtime/rhi/RHITexture.hpp