1. Epic GamesDeveloper
  3. FRHITexture

FRHITexture

API > API/Runtime > API/Runtime/RHI

Inheritance Hierarchy

References

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

Syntax

class FRHITexture : public FRHIViewableResource

Constructors

  Type Name Description
Protected function   Initialization constructor. Should only be called by platform RHI implementations.

Functions

  Type Name Description
Public function Const FLinearColor  
Public function Virtual Const FRHIDescriptorHandle  
Public function Const float  
Public function Const void

GetDepthStencilClearValue ( float& OutDepth,
uint32& OutStencil
)

  
Public function Virtual Const 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
Public function Const double  
Public function Const FIntVector

GetMipDimensions ( uint8 MipIndex
)

 Returns the dimensions (i.e. the actual number of texels in each dimension) of the specified mip.
Public function Virtual Const void * Returns access to the platform-specific native resource pointer.
Public function Virtual Const void * Returns access to the platform-specific native shader resource view pointer.
Public function Const FIntVector 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
Public function Const uint32  
Public function Virtual void * Returns access to the platform-specific RHI texture baseclass.
Public function Virtual FRHITextureReference * Virtual functions implemented per RHI
Public function Virtual void

GetWriteMaskProperties ( void*& OutData,
uint32& OutSize
)

  
Public function Const bool  
Public function Const bool  
Public function void

SetLastRenderTime ( float InLastRenderTime
)

 RenderTime & Name functions - non virtualsets the last time this texture was cached in a resource table.
Public function void

SetName ( const FName& InName
)

  

Deprecated Functions

  Type Name Description
Public function Const const FClearValueBinding GetClearBinding() is deprecated, please use GetDesc().ClearValue instead
Public function Const ETextureCreateFlags GetFlags() is deprecated, please use GetDesc().Flags instead
Public function Const EPixelFormat GetFormat() is deprecated, please use GetDesc().Format instead
Public function Const uint32 GetNumMips() is deprecated, please use GetDesc().NumMips instead
Public function Const uint32 GetNumSamples() is deprecated, please use GetDesc().NumSamples instead
Public function Const uint32

GetSize ()

 GetSize() is deprecated, please use GetDesc().Extent.X instead
Public function Const uint32 GetSizeX() is deprecated, please use GetDesc().Extent.X instead
Public function Const FIntPoint GetSizeXY() is deprecated, please use GetDesc().Extent.X or GetDesc().Extent.Y instead
Public function Const uint32 GetSizeY() is deprecated, please use GetDesc().Extent.Y instead
Public function Const uint32 GetSizeZ() is deprecated, please use GetDesc().ArraySize instead for TextureArrays and GetDesc().Depth for 3D textures
Public function FRHITexture2D * FRHITexture2D is deprecated, please use FRHITexture directly
Public function FRHITexture2DArray * FRHITexture2DArray is deprecated, please use FRHITexture directly
Public function FRHITexture3D * FRHITexture3D is deprecated, please use FRHITexture directly
Public function FRHITextureCube * FRHITextureCube is deprecated, please use FRHITexture directly

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page