1. Epic GamesDeveloper
  3. FRHITextureDesc

FRHITextureDesc

Descriptor used to create a texture resource

API > API/Runtime > API/Runtime/RHI

Inheritance Hierarchy

References

   
Module RHI
Header /Engine/Source/Runtime/RHI/Public/RHIResources.h
Include #include "RHIResources.h"

Syntax

struct FRHITextureDesc

Remarks

Descriptor used to create a texture resource

Variables

  Type Name Description
Public variable uint16 ArraySize The number of array elements in the texture. (Keep at 1 if dimension is 3D).
Public variable FClearValueBinding ClearValue Clear value to use when fast-clearing the texture.
Public variable uint16 Depth Depth of the texture if the dimension is 3D.
Public variable ETextureDimension Dimension Texture dimension to use when creating the RHI texture.
Public variable uint32 ExtData Platform-specific additional data. Used for offline processed textures on some platforms.
Public variable FIntPoint Extent Extent of the texture in x and y.
Public variable uint8 FastVRAMPercentage Resource memory percentage which should be allocated onto fast VRAM (hint-only).
Public variable ETextureCreateFlags Flags Texture flags passed on to RHI texture.
Public variable EPixelFormat Format Pixel format used to create RHI texture.
Public variable FRHIGPUMask GPUMask A mask representing which GPUs to create the resource on, in a multi-GPU system.
Public variable uint8 NumMips Number of mips in the texture mip-map chain.
Public variable uint8 NumSamples Number of samples in the texture. >1 for MSAA.
Public variable EPixelFormat UAVFormat Texture format used when creating the UAV.

Constructors

  Type Name Description
Public function    
Public function  

FRHITextureDesc ( const FRHITextureDesc& Other
)

  
Public function  

FRHITextureDesc ( ETextureDimension InDimension
)

  
Public function  

FRHITextureDesc ( ETextureDimension InDimension,
ETextureCreateFlags InFlags,
EPixelFormat InFormat,
FClearValueBinding InClearValue,
FIntPoint InExtent,
uint16 InDepth,
uint16 InArraySize,
uint8 InNumMips,
uint8 InNumSamples,
uint32 InExtData
)

  

Functions

  Type Name Description
Public function Const uint64

CalcMemorySizeEstimate ( uint32 FirstMipIndex,
uint32 LastMipIndex
)

 Returns an estimated total memory size the described texture will occupy in GPU memory.
Public function Const uint64

CalcMemorySizeEstimate ( uint32 FirstMipIndex
)

  
Public function Static bool

CheckValidity ( const FRHITextureDesc& Desc,
const TCHAR* Name
)

 Check the validity.
Public function Const FIntVector

GetSize ()

  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool

IsValid ()

 Returns whether this descriptor conforms to requirements.
Public function void

Reset ()

  

Operators

  Type Name Description
Public function Const bool

operator!= ( const FRHITextureDesc& Other
)

  
Public function FRHITextureDesc &

operator= ( const FRHITextureDesc& Other
)

  
Public function Const bool

operator== ( const FRHITextureDesc& Other
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page