FNullDynamicRHI::RHILockTextureCubeFace

FlushType: Flush RHI Thread.

Windows
MacOS
Linux

Override Hierarchy

FDynamicRHI::RHILockTextureCubeFace()

FNullDynamicRHI::RHILockTextureCubeFace()

References

Module

NullDrv

Header

/Engine/Source/Runtime/NullDrv/Public/NullRHI.h

Include

#include "NullRHI.h"

Syntax

virtual void * RHILockTextureCubeFace
(
    FRHITextureCube * Texture,
    uint32 FaceIndex,
    uint32 ArrayIndex,
    uint32 MipIndex,
    EResourceLockMode LockMode,
    uint32 & DestStride,
    bool bLockWithinMiptail
)

Remarks

Locks an RHI texture's mip-map for read/write operations on the CPU

Returns

pointer to the CPU accessible resource data

Parameters

Parameter

Description

Texture

the RHI texture resource to lock

MipIndex

index of the mip level to lock

LockMode

Whether to lock the texture read-only instead of write-only.

DestStride

output to retrieve the textures row stride (pitch)

bLockWithinMiptail

for platforms that support packed miptails allow locking of individual mip levels within the miptail
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss