Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

FSlateTexture2DRHIRef

Encapsulates a Texture2DRHIRef for use by a Slate rendering implementation

Windows

MacOS

Linux

Inheritance Hierarchy

TSlateTexture

FSlateUpdatableTexture

FDeferredCleanupInterface

FRenderResource

FSlateTexture2DRHIRef

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Public/Slate/SlateTextures.h
Include	#include "Slate/SlateTextures.h"

Syntax

Remarks

Encapsulates a Texture2DRHIRef for use by a Slate rendering implementation

Variables

		Name	Description
	uint32	Height	Height of this texture
	uint32	Width	Width of this texture

Constructors

	Name	Description
	FSlateTexture2DRHIRef ( FTexture2DRHIRef InRef, uint32 InWidth, uint32 InHeight )
	FSlateTexture2DRHIRef ( uint32 InWidth, uint32 InHeight, EPixelFormat InPixelFormat, TSharedPtr< FSlateTextureData, ESPM..., ETextureCreateFlags InTexCreateFlag..., bool bCreateEmptyTexture )

Destructors

	Name	Description
	~FSlateTexture2DRHIRef()

Functions

	Name	Description
void	ClearTextureData()	Clears texture data being used. Can only be accessed on the render thread
EPixelFormat	GetPixelFormat()	Returns the pixel format of this texture
FTexture2DRH...	GetRHIRef()
bool	IsValid()
void	Resize ( uint32 Width, uint32 Height )	Resize the texture. Can only be called on the render thread
void	SetRHIRef ( FTexture2DRHIRef InRenderTargetText..., uint32 InWidth, uint32 InHeight )	Sets the RHI Ref to use.
void	SetTextureData ( FSlateTextureDataPtr NewTextureData )	Sets the bulk data for this texture.
void	SetTextureData ( FSlateTextureDataPtr NewTextureData, EPixelFormat InPixelFormat, ETextureCreateFlags InTexCreateFlag... )	Sets the bulk data for this texture and the format of the rendering resource

Overridden from FSlateShaderResource

		Name	Description
	uint32	GetHeight()	Gets the height of the resource.
	uint32	GetWidth()	Gets the width of the resource.

Overridden from FSlateUpdatableTexture

	Name	Description
void	Cleanup()	Deferred or Immediate cleanup of this data depending on what is required.
FRenderResou...	GetRenderResource()	Gets the interface to the underlying render resource (may not always be used)
FSlateShader...	GetSlateResource()	Gets the interface to the underlying platform independent texture
void	ResizeTexture ( uint32 Width, uint32 Height )	Resize the texture.
void	UpdateTexture ( const TArray< uint8 >& Bytes )	Updates the texture contents via a byte array.
void	UpdateTextureThreadSafe ( const TArray< uint8 >& Bytes )	Updates the texture contents via a byte array making a copy first for thread safety
void	UpdateTextureThreadSafeRaw ( uint32 Width, uint32 Height, const void* Buffer, const FIntRect& Dirty )	Update the texture from a raw byte buffer.
void	UpdateTextureThreadSafeWithTextureData ( FSlateTextureData* TextureData )	Update the texture from a provided FSlateTextureData buffer, also transferring ownership of the texture

Overridden from FRenderResource

		Name	Description
	void	InitDynamicRHI()	FRenderResource Interface.
	void	ReleaseDynamicRHI()	FRenderResource Interface.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss