Navigation
API > API/Runtime > API/Runtime/RHI
| Name | FRHITexture |
| Type | class |
| Header File | /Engine/Source/Runtime/RHI/Public/RHIResources.h |
| Include Path | #include "RHIResources.h" |
Syntax
class FRHITexture : public FRHIViewableResource
Inheritance Hierarchy
- FRHIResource → FRHIViewableResource → FRHITexture
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FRHITexture
(
ERHIResourceType InResourceType |
Constructor for texture references | RHIResources.h | |
FRHITexture
(
const FRHITextureCreateDesc& InDesc |
Initialization constructor. Should only be called by platform RHI implementations. | RHIResources.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| LastRenderTime | FLastRenderTimeContainer | RHIResources.h | ||
| TextureDesc | FRHITextureDesc | RHIResources.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const FClearValueBinding GetClearBinding() |
RHIResources.h | ||
FLinearColor GetClearColor() |
RHIResources.h | ||
virtual FRHIDescriptorHandle GetDefaultBindlessHandle() |
RHIResources.h | ||
float GetDepthClearValue() |
RHIResources.h | ||
void GetDepthStencilClearValue
(
float& OutDepth, |
RHIResources.h | ||
virtual const FRHITextureDesc & GetDesc() |
Get the texture description used to create the texture Still virtual because FRHITextureReference can override this function - remove virtual when FRHITextureReference is deprecated | RHIResources.h | |
ETextureCreateFlags GetFlags() |
RHIResources.h | ||
EPixelFormat GetFormat() |
RHIResources.h | ||
double GetLastRenderTime() |
RHIResources.h | ||
FIntVector GetMipDimensions
(
uint8 MipIndex |
Returns the dimensions (i.e. the actual number of texels in each dimension) of the specified mip. | RHIResources.h | |
virtual void * GetNativeResource () |
Returns access to the platform-specific native resource pointer. | RHIResources.h | |
virtual void * GetNativeShaderResourceView () |
Returns access to the platform-specific native shader resource view pointer. | RHIResources.h | |
uint32 GetNumMips() |
RHIResources.h | ||
uint32 GetNumSamples() |
RHIResources.h | ||
uint32 GetSize() |
RHIResources.h | ||
uint32 GetSizeX() |
RHIResources.h | ||
FIntPoint GetSizeXY() |
RHIResources.h | ||
FIntVector GetSizeXYZ() |
Helper getter functions - non virtual Returns the x, y & z dimensions if the texture The Z component will always be 1 for 2D/cube resources and will contain depth for volume textures & array size for array textures | RHIResources.h | |
uint32 GetSizeY() |
RHIResources.h | ||
uint32 GetSizeZ() |
RHIResources.h | ||
uint32 GetStencilClearValue() |
RHIResources.h | ||
FRHITexture * GetTexture2D() |
Deprecated functions | RHIResources.h | |
FRHITexture * GetTexture2DArray() |
RHIResources.h | ||
FRHITexture * GetTexture3D() |
RHIResources.h | ||
virtual void * GetTextureBaseRHI () |
Returns access to the platform-specific RHI texture baseclass. | RHIResources.h | |
FRHITexture * GetTextureCube() |
RHIResources.h | ||
virtual FRHITextureReference * GetTextureReference() |
Virtual functions implemented per RHI | RHIResources.h | |
virtual void GetWriteMaskProperties
(
void*& OutData, |
RHIResources.h | ||
bool HasClearValue() |
RHIResources.h | ||
bool IsMultisampled() |
RHIResources.h | ||
FORCEINLINE_DEBUGGABLE void SetLastRenderTime
(
float InLastRenderTime |
RenderTime & Name functions - non virtual sets the last time this texture was cached in a resource table. | RHIResources.h | |
void SetName
(
FName InName |
RHIResources.h |