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

FStreamableTextureResource

The rendering resource streamable texture.

Windows

MacOS

Linux

Inheritance Hierarchy

FRenderResource

FTexture

FTextureResource

FStreamableTextureResource

FTexture2DResource

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Public/Rendering/StreamableTextureResource.h
Include	#include "Rendering/StreamableTextureResource.h"

Syntax

class FStreamableTextureResource : public FTextureResource

Remarks

The rendering resource streamable texture.

Variables

	Name	Description
TEnumAsByte< ES...	AddressU
TEnumAsByte< ES...	AddressV
TEnumAsByte< ES...	AddressW
bool	bUsePartiallyResidentMips	Whether this texture should be updated using the virtual address mapping for each mip.
ETextureCreateF...	CreationFlags	Creation flags of the texture
TEnumAsByte< ES...	Filter	Sample config
TextureGroup	LODGroup	The asset LOD group
float	MipBias
EMipFadeSetting...	MipFadeSetting	Mip fade settings
EPixelFormat	PixelFormat	Format of the texture
const FTextureP...	PlatformData	Platform data should be ref counted eventually to remove any synchronization needed when the asset is rebuild.
uint32	SizeX	The width this resource, when all mips are streamed in.
uint32	SizeY	The height when all mips are streamed in.
uint32	SizeZ	The depth when all mips are streamed in.
FStreamableRend...	State	Different states for streaming synchronization.
FName	TextureName	The FName of the texture asset

Constructors

	Name	Description
	FStreamableTextureResource ( UTexture* InOwner, const FTexturePlatformData* In..., const FStreamableRenderResourceStat..., bool bAllowPartiallyResidentMips )

Functions

	Name	Description
void	CreatePartiallyResidentTexture()
void	CreateTexture()
void	FinalizeStreaming ( FRHITexture* InTextureRHI )
ETextureCrea...	GetCreationFlags()	Return the texture creation flags, does not include TexCreate_Virtual as it could change per mip. Use IsTextureRHIPartiallyResident() instead.
int32	GetCurrentFirstMip()	Get the current first mip index, of this renderthread resource. Non streaming asset always return 0.
TextureGroup	GetLODGroup()
EPixelFormat	GetPixelFormat()
const FTextu...	GetPlatformMip ( int32 MipIdx )	Return the platform data mips, zero based on the resource mip count and not to the asset mip count.
TArrayView< ...	GetPlatformMipsView()	Return the platform data mips, zero based on the resource mip count and not to the asset mip count.
FStreamableR...	GetPostInitState()	Get the state it will be in after InitRHI() gets called. Used to synchronize UStreamableRenderResource.CacheStreamableResourceState in CreateResource().
FStreamableR...	GetState()	This is only coherent sync on the rendering thread. To get the gamethread coherent value, use UStreamableRenderResource.CacheStreamableResourceState.
const FName ...	GetTextureName()
void	RefreshSamplerStates()	Returns the default mip map bias for this texture.

Overridden from FTextureResource

		Name	Description
	FStreamableT...	GetStreamableTextureResource()	Dynamic cast methods.
	const FStrea...	GetStreamableTextureResource()	Dynamic cast methods (const).

Overridden from FTexture

	Name	Description
uint32	GetSizeX()	Returns the width of the texture in pixels.
uint32	GetSizeY()	Returns the height of the texture in pixels.
uint32	GetSizeZ()	Returns the depth of the texture in pixels.

Overridden from FRenderResource

		Name	Description
	void	InitRHI()	Initializes the RHI resources used by this resource.
	void	ReleaseRHI()	Releases the RHI resources used by this resource.

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

Take our survey

Dismiss