FOpenGLDynamicRHI::RHILockTexture2D

FlushType: Flush RHI Thread.

Windows
MacOS
Linux

Override Hierarchy

FDynamicRHI::RHILockTexture2D()

FOpenGLDynamicRHI::RHILockTexture2D()

References

Module

OpenGLDrv

Header

/Engine/Source/Runtime/OpenGLDrv/Public/OpenGLDrv.h

Include

#include "OpenGLDrv.h"

Source

/Engine/Source/Runtime/OpenGLDrv/Private/OpenGLTexture.cpp

Syntax

virtual void * RHILockTexture2D
(
    FRHITexture2D * Texture,
    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, must not be 0

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

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback