UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FRHILockTextureArgs Struct Reference

#include <DynamicRHI.h>

+ Inheritance diagram for FRHILockTextureArgs:

Static Public Member Functions

static FRHILockTextureArgs Lock2D (FRHITexture *InTexture, uint32 InMipIndex, EResourceLockMode InLockMode, bool bInLockWithinMiptail, bool bFlushRHIThread=true)
 
static FRHILockTextureArgs Lock2DArray (FRHITexture *InTexture, uint32 InArrayIndex, uint32 InMipIndex, EResourceLockMode InLockMode, bool bInLockWithinMiptail)
 
static FRHILockTextureArgs LockCubeFace (FRHITexture *InTexture, uint32 InFaceIndex, uint32 InArrayIndex, uint32 InMipIndex, EResourceLockMode InLockMode, bool bInLockWithinMiptail)
 

Public Attributes

EResourceLockMode LockMode = RLM_Num
 
bool bLockWithinMiptail = false
 
bool bNeedsDefaultRHIFlush = false
 
- Public Attributes inherited from FRHILockedTextureDesc
FRHITextureTexture = nullptr
 
uint32 FaceIndex = 0
 
uint32 ArrayIndex = 0
 
uint32 MipIndex = 0
 

Protected Member Functions

 FRHILockTextureArgs ()=default
 

Additional Inherited Members

- Public Member Functions inherited from FRHILockedTextureDesc
bool operator== (const FRHILockedTextureDesc &Other) const
 
bool operator!= (const FRHILockedTextureDesc &Other) const
 

Constructor & Destructor Documentation

◆ FRHILockTextureArgs()

FRHILockTextureArgs::FRHILockTextureArgs ( )
protecteddefault

Member Function Documentation

◆ Lock2D()

static FRHILockTextureArgs FRHILockTextureArgs::Lock2D ( FRHITexture InTexture,
uint32  InMipIndex,
EResourceLockMode  InLockMode,
bool  bInLockWithinMiptail,
bool  bFlushRHIThread = true 
)
inlinestatic

◆ Lock2DArray()

static FRHILockTextureArgs FRHILockTextureArgs::Lock2DArray ( FRHITexture InTexture,
uint32  InArrayIndex,
uint32  InMipIndex,
EResourceLockMode  InLockMode,
bool  bInLockWithinMiptail 
)
inlinestatic

◆ LockCubeFace()

static FRHILockTextureArgs FRHILockTextureArgs::LockCubeFace ( FRHITexture InTexture,
uint32  InFaceIndex,
uint32  InArrayIndex,
uint32  InMipIndex,
EResourceLockMode  InLockMode,
bool  bInLockWithinMiptail 
)
inlinestatic

Member Data Documentation

◆ bLockWithinMiptail

bool FRHILockTextureArgs::bLockWithinMiptail = false

◆ bNeedsDefaultRHIFlush

bool FRHILockTextureArgs::bNeedsDefaultRHIFlush = false

◆ LockMode

EResourceLockMode FRHILockTextureArgs::LockMode = RLM_Num

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