FRHIBufferCreateDesc Struct Reference

#include <RHIResources.h>

Inheritance diagram for FRHIBufferCreateDesc:

Public Member Functions
	FRHIBufferCreateDesc ()=default
	FRHIBufferCreateDesc (const TCHAR *InDebugName, EBufferUsageFlags InUsage)
	FRHIBufferCreateDesc (const TCHAR *InDebugName, uint32 InSize, uint32 InStride, EBufferUsageFlags InUsage)
	FRHIBufferCreateDesc (const TCHAR *InDebugName, const FRHIBufferDesc &InOtherDesc)
FRHIBufferCreateDesc &	SetSize (uint32 InSize)
FRHIBufferCreateDesc &	SetStride (uint32 InStride)
FRHIBufferCreateDesc &	SetUsage (EBufferUsageFlags InUsage)
FRHIBufferCreateDesc &	AddUsage (EBufferUsageFlags InUsage)
FRHIBufferCreateDesc &	SetGPUMask (FRHIGPUMask InGPUMask)
FRHIBufferCreateDesc &	SetDebugName (const TCHAR *InDebugName)
FRHIBufferCreateDesc &	SetInitialState (ERHIAccess InInitialState)
FRHIBufferCreateDesc &	DetermineInitialState ()
FRHIBufferCreateDesc &	SetInitAction (ERHIBufferInitAction InInitAction)
FRHIBufferCreateDesc &	SetClassName (FName InClassName)
FRHIBufferCreateDesc &	SetOwnerName (FName InOwnerName)
FRHIBufferCreateDesc &	SetInitActionNone ()
FRHIBufferCreateDesc &	SetInitActionZeroData ()
FRHIBufferCreateDesc &	SetInitActionInitializer ()
FRHIBufferCreateDesc &	SetInitActionResourceArray (FResourceArrayUploadInterface *InInitialData)
FName	GetTraceClassName () const
Public Member Functions inherited from FRHIBufferDesc
	FRHIBufferDesc ()=default
	FRHIBufferDesc (uint32 InSize, uint32 InStride, EBufferUsageFlags InUsage)
	FRHIBufferDesc (uint32 InSize, uint32 InStride, EBufferUsageFlags InUsage, FRHIGPUMask InGPUMask)
bool	IsNull () const
bool	operator== (const FRHIBufferDesc &Other) const
bool	operator!= (const FRHIBufferDesc &Other) const
FRHIBufferDesc &	operator= (const FRHIBufferDesc &Other)

Static Public Member Functions
static FRHIBufferCreateDesc	Create (const TCHAR *InDebugName, EBufferUsageFlags InUsage)
static FRHIBufferCreateDesc	Create (const TCHAR *InDebugName, uint32 InSize, uint32 InStride, EBufferUsageFlags InUsage)
static FRHIBufferCreateDesc	Create (const TCHAR *InDebugName, const FRHIBufferDesc &InDesc)
static FRHIBufferCreateDesc	CreateNull (const TCHAR *InDebugName)
static FRHIBufferCreateDesc	CreateVertex (const TCHAR *InDebugName)
static FRHIBufferCreateDesc	CreateVertex (const TCHAR *InDebugName, uint32 InSize)
template<typename TVertexType >
static FRHIBufferCreateDesc	CreateVertex (const TCHAR *InDebugName, uint32 InCount)
static FRHIBufferCreateDesc	CreateIndex (const TCHAR *InDebugName)
static FRHIBufferCreateDesc	CreateIndex (const TCHAR *InDebugName, uint32 InSize, uint32 InStride)
template<typename TIndexType >
static FRHIBufferCreateDesc	CreateIndex (const TCHAR *InDebugName, uint32 InCount)
static FRHIBufferCreateDesc	CreateStructured (const TCHAR *InDebugName)
static FRHIBufferCreateDesc	CreateStructured (const TCHAR *InDebugName, uint32 InSize, uint32 InStride)
template<typename TStructureType >
static FRHIBufferCreateDesc	CreateStructured (const TCHAR *InDebugName, uint32 InCount)
static FRHIBufferCreateDesc	CreateByteAddress (const TCHAR *InDebugName)
static FRHIBufferCreateDesc	CreateByteAddress (const TCHAR *InDebugName, uint32 InSize, uint32 InStride)
static FRHIBufferCreateDesc	CreateUniform (const TCHAR *InDebugName)
Static Public Member Functions inherited from FRHIBufferDesc
static FRHIBufferDesc	Null ()

Public Attributes
const TCHAR *	DebugName = nullptr
FResourceArrayUploadInterface *	InitialData = nullptr
ERHIAccess	InitialState = ERHIAccess::Unknown
ERHIBufferInitAction	InitAction = ERHIBufferInitAction::Default
FName	ClassName = NAME_None
FName	OwnerName = NAME_None
Public Attributes inherited from FRHIBufferDesc
uint32	Size = 0
uint32	Stride = 0
EBufferUsageFlags	Usage = EBufferUsageFlags::None
FRHIGPUMask	GPUMask = FRHIGPUMask::All()

Constructor & Destructor Documentation

FRHIBufferCreateDesc() [1/4]

FRHIBufferCreateDesc::FRHIBufferCreateDesc ( )

default

FRHIBufferCreateDesc() [2/4]

FRHIBufferCreateDesc::FRHIBufferCreateDesc ( const TCHAR *  InDebugName, EBufferUsageFlags  InUsage  )

inline

FRHIBufferCreateDesc() [3/4]

FRHIBufferCreateDesc::FRHIBufferCreateDesc ( const TCHAR *  InDebugName, uint32  InSize, uint32  InStride, EBufferUsageFlags  InUsage  )

inline

FRHIBufferCreateDesc() [4/4]

FRHIBufferCreateDesc::FRHIBufferCreateDesc ( const TCHAR *  InDebugName, const FRHIBufferDesc &  InOtherDesc  )

inline

Member Function Documentation

AddUsage()

FRHIBufferCreateDesc & FRHIBufferCreateDesc::AddUsage ( EBufferUsageFlags  InUsage )

inline

Create() [1/3]

static FRHIBufferCreateDesc FRHIBufferCreateDesc::Create ( const TCHAR *  InDebugName, const FRHIBufferDesc &  InDesc  )

inlinestatic

Create() [2/3]

static FRHIBufferCreateDesc FRHIBufferCreateDesc::Create ( const TCHAR *  InDebugName, EBufferUsageFlags  InUsage  )

inlinestatic

Create() [3/3]

static FRHIBufferCreateDesc FRHIBufferCreateDesc::Create ( const TCHAR *  InDebugName, uint32  InSize, uint32  InStride, EBufferUsageFlags  InUsage  )

inlinestatic

CreateByteAddress() [1/2]

static FRHIBufferCreateDesc FRHIBufferCreateDesc::CreateByteAddress ( const TCHAR *  InDebugName )

inlinestatic

CreateByteAddress() [2/2]

static FRHIBufferCreateDesc FRHIBufferCreateDesc::CreateByteAddress ( const TCHAR *  InDebugName, uint32  InSize, uint32  InStride  )

inlinestatic

CreateIndex() [1/3]

static FRHIBufferCreateDesc FRHIBufferCreateDesc::CreateIndex ( const TCHAR *  InDebugName )

inlinestatic

CreateIndex() [2/3]

template<typename TIndexType >

static FRHIBufferCreateDesc FRHIBufferCreateDesc::CreateIndex ( const TCHAR *  InDebugName, uint32  InCount  )

inlinestatic

CreateIndex() [3/3]

static FRHIBufferCreateDesc FRHIBufferCreateDesc::CreateIndex ( const TCHAR *  InDebugName, uint32  InSize, uint32  InStride  )

inlinestatic

CreateNull()

static FRHIBufferCreateDesc FRHIBufferCreateDesc::CreateNull ( const TCHAR *  InDebugName )

inlinestatic

CreateStructured() [1/3]

static FRHIBufferCreateDesc FRHIBufferCreateDesc::CreateStructured ( const TCHAR *  InDebugName )

inlinestatic

CreateStructured() [2/3]

template<typename TStructureType >

static FRHIBufferCreateDesc FRHIBufferCreateDesc::CreateStructured ( const TCHAR *  InDebugName, uint32  InCount  )

inlinestatic

CreateStructured() [3/3]

static FRHIBufferCreateDesc FRHIBufferCreateDesc::CreateStructured ( const TCHAR *  InDebugName, uint32  InSize, uint32  InStride  )

inlinestatic

CreateUniform()

static FRHIBufferCreateDesc FRHIBufferCreateDesc::CreateUniform ( const TCHAR *  InDebugName )

inlinestatic

CreateVertex() [1/3]

static FRHIBufferCreateDesc FRHIBufferCreateDesc::CreateVertex ( const TCHAR *  InDebugName )

inlinestatic

CreateVertex() [2/3]

template<typename TVertexType >

static FRHIBufferCreateDesc FRHIBufferCreateDesc::CreateVertex ( const TCHAR *  InDebugName, uint32  InCount  )

inlinestatic

CreateVertex() [3/3]

static FRHIBufferCreateDesc FRHIBufferCreateDesc::CreateVertex ( const TCHAR *  InDebugName, uint32  InSize  )

inlinestatic

DetermineInitialState()

FRHIBufferCreateDesc & FRHIBufferCreateDesc::DetermineInitialState ( )

inline

GetTraceClassName()

FName FRHIBufferCreateDesc::GetTraceClassName ( ) const

inline

SetClassName()

FRHIBufferCreateDesc & FRHIBufferCreateDesc::SetClassName ( FName  InClassName )

inline

SetDebugName()

FRHIBufferCreateDesc & FRHIBufferCreateDesc::SetDebugName ( const TCHAR *  InDebugName )

inline

SetGPUMask()

FRHIBufferCreateDesc & FRHIBufferCreateDesc::SetGPUMask ( FRHIGPUMask  InGPUMask )

inline

SetInitAction()

FRHIBufferCreateDesc & FRHIBufferCreateDesc::SetInitAction ( ERHIBufferInitAction  InInitAction )

inline

SetInitActionInitializer()

FRHIBufferCreateDesc & FRHIBufferCreateDesc::SetInitActionInitializer ( )

inline

SetInitActionNone()

FRHIBufferCreateDesc & FRHIBufferCreateDesc::SetInitActionNone ( )

inline

SetInitActionResourceArray()

FRHIBufferCreateDesc & FRHIBufferCreateDesc::SetInitActionResourceArray ( FResourceArrayUploadInterface *  InInitialData )

inline

SetInitActionZeroData()

FRHIBufferCreateDesc & FRHIBufferCreateDesc::SetInitActionZeroData ( )

inline

SetInitialState()

FRHIBufferCreateDesc & FRHIBufferCreateDesc::SetInitialState ( ERHIAccess  InInitialState )

inline

SetOwnerName()

FRHIBufferCreateDesc & FRHIBufferCreateDesc::SetOwnerName ( FName  InOwnerName )

inline

SetSize()

FRHIBufferCreateDesc & FRHIBufferCreateDesc::SetSize ( uint32  InSize )

inline

SetStride()

FRHIBufferCreateDesc & FRHIBufferCreateDesc::SetStride ( uint32  InStride )

inline

SetUsage()

FRHIBufferCreateDesc & FRHIBufferCreateDesc::SetUsage ( EBufferUsageFlags  InUsage )

inline

Member Data Documentation

ClassName

FName FRHIBufferCreateDesc::ClassName = NAME_None

DebugName

const TCHAR* FRHIBufferCreateDesc::DebugName = nullptr

InitAction

ERHIBufferInitAction FRHIBufferCreateDesc::InitAction = ERHIBufferInitAction::Default

InitialData

FResourceArrayUploadInterface* FRHIBufferCreateDesc::InitialData = nullptr

InitialState

ERHIAccess FRHIBufferCreateDesc::InitialState = ERHIAccess::Unknown

OwnerName

FName FRHIBufferCreateDesc::OwnerName = NAME_None

---

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

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