Navigation
API > API/Runtime > API/Runtime/RHI
Structure used to allow optimal texture initialization at creation time. Should only ever be obtained by calling RHICreateTextureInitializer(). Texture data writing has to be done on individual subresources via the GetSubresource accesors. NO COPIES ALLOWED
| Name | FRHITextureInitializer |
| Type | struct |
| Header File | /Engine/Source/Runtime/RHI/Public/RHITextureInitializer.h |
| Include Path | #include "RHITextureInitializer.h" |
Syntax
struct FRHITextureInitializer
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FRHITextureInitializer
(
FRHICommandListBase& RHICmdList, |
Should only be called by RHI derived types. | RHITextureInitializer.h | |
FRHITextureInitializer
(
const FRHITextureInitializer& |
Allow copies only for RHI derived types. | RHITextureInitializer.h | |
FRHITextureInitializer
(
FRHITextureInitializer&& InOther |
RHITextureInitializer.h | ||
| RHITextureInitializer.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FRHITextureInitializer() |
RHITextureInitializer.h |
Structs
| Name | Remarks |
|---|---|
| FSubresourceIndex |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FFinalizeCallback | TUniqueFunction< FTextureRHIRef(FRHICommandListBase &)> | RHITextureInitializer.h | |
| FGetSubresourceCallback | TUniqueFunction< FRHITextureSubresourceInitializer(FSubresourceIndex)> | FaceIndex, ArrayIndex, MipIndex. | RHITextureInitializer.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FTextureRHIRef Finalize() |
'Finalizes' the initializer and returns the created FRHITexture. The initializer will be reset to an invalid state and should not be used after calling this. | RHITextureInitializer.h | |
const FRHITextureMinimalDesc & GetDesc() |
RHITextureInitializer.h | ||
FRHITextureSubresourceInitializer GetSubresource
(
FSubresourceIndex SubresourceIndex |
Get a subresource for any texture type. | RHITextureInitializer.h | |
FRHITextureSubresourceInitializer GetTexture2DArraySubresource
(
int32 ArrayIndex, |
Get a subresource for a 2D texture array. Subresources are individual array slice mip levels. | RHITextureInitializer.h | |
FRHITextureSubresourceInitializer GetTexture2DSubresource
(
int32 MipIndex |
Get a subresource for a 2D texture. The only subresources are mip levels. | RHITextureInitializer.h | |
FRHITextureSubresourceInitializer GetTexture3DSubresource
(
int32 MipIndex |
Get a subresource for a 3D texture. The only subresources are mip levels. | RHITextureInitializer.h | |
FRHITextureSubresourceInitializer GetTextureCubeArraySubresource
(
int32 FaceIndex, |
Get a subresource for a cube texture array. Subresources are individual array slice face mip levels. | RHITextureInitializer.h | |
FRHITextureSubresourceInitializer GetTextureCubeSubresource
(
int32 FaceIndex, |
Get a subresource for a cube texture. Subresources are individual face mip levels. | RHITextureInitializer.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void RemovePendingTextureUpload() |
Remove the texture from the command list. Has to be in cpp file to prevent circular header dependency. | RHITextureInitializer.h | |
void Reset() |
RHITextureInitializer.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FRHITextureInitializer & operator=
(
const FRHITextureInitializer& |
RHITextureInitializer.h | ||
| RHITextureInitializer.h |