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

UMediaTexture

Implements a texture asset for rendering video tracks from [UMediaPlayer](API\Runtime\MediaAssets\UMediaPlayer) assets.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UStreamableRenderAsset

UTexture

UMediaTexture

References

Module	MediaAssets
Header	/Engine/Source/Runtime/MediaAssets/Public/MediaTexture.h
Include	#include "MediaTexture.h"

Syntax

class UMediaTexture : public UTexture

Remarks

Implements a texture asset for rendering video tracks from UMediaPlayer assets.

Variables

	Name	Description
TEnumAsByte< Te...	AddressX	The addressing mode to use for the X axis.
TEnumAsByte< Te...	AddressY	The addressing mode to use for the Y axis.
bool	AutoClear	Whether to clear the texture when no media is being played (default = enabled).
FLinearColor	ClearColor	The color used to clear the texture if AutoClear is enabled (default = black).
float	CurrentAspectRatio	Current aspect ratio
TEnumAsByte< en...	CurrentOrientation	Current media orientation
bool	EnableGenMips	Basic enablement for mip generation (default = false).
TObjectPtr< UMe...	MediaPlayer	The media player asset associated with this texture.
bool	NewStyleOutput	Enable new style output (default = false).
uint8	NumMips	The number of mips to use (default = 1).
TEnumAsByte< en...	OutputFormat

Constructors

	Name	Description
	UMediaTexture ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
void	CacheNextAvailableSampleTime ( FTimespan InNextSampleTime )	Caches the next available sample time from the queue when last rendering was made
float	GetAspectRatio()	Gets the current aspect ratio of the texture.
int32	GetAvailableSampleCount()	Gets the number of samples that are available
float	GetCurrentAspectRatio()	Get current aspect ratio of presented frame.
MediaTexture...	GetCurrentOrientation()	Get current orientation of presented frame.
int32	GetHeight()	Gets the current height of the texture.
UMediaPlayer...	GetMediaPlayer()	Get the media player that provides the video samples.
FTimespan	GetNextSampleTime()	Gets the next sample Time.
int32	GetTextureNumMips()	Gets the current numbe of mips of the texture.
int32	GetWidth()	Gets the current width of the texture.
void	SetDefaultMediaPlayer ( UMediaPlayer* NewMediaPlayer )	Set the texture's default media player property.
void	SetMediaPlayer ( UMediaPlayer* NewMediaPlayer )	Set the media player that provides the video samples.
void	SetRenderedExternalTextureGuid ( const FGuid& InNewGuid )
void	TickResource ( FTimespan Timecode )	Tick the texture resource.
void	UpdatePlayerAndQueue()	Update the video sample queue, if necessary.
void	UpdateSampleInfo ( const TSharedPtr< IMediaTextureSamp... )	Update sample info

Overridden from UTexture

	Name	Description
FTextureReso...	CreateResource()	Implemented by subclasses to create a new resource for the texture.
FGuid	GetExternalTextureGuid()	Access the GUID which defines this texture's resources externally through FExternalTextureRegistry
EMaterialVal...	GetMaterialType()
uint32	GetSurfaceArraySize()
float	GetSurfaceDepth()
float	GetSurfaceHeight()
float	GetSurfaceWidth()
void	UpdateResource()	Creates a new resource for the texture, and updates any cached references to the resource.

Overridden from UObject

	Name	Description
void	BeginDestroy()	Called before destroying the object.
FString	GetDesc()	Return a one line description of an object for viewing in the thumbnail view of the generic browser
void	GetResourceSizeEx ( FResourceSizeEx& CumulativeResourc... )	Get the size of the object/resource for use in memory tools or to display to artists/LDs in the Editor This is the extended version which separates up the used memory into different memory regions (the actual definition of which may be platform specific).
bool	IsPostLoadThreadSafe()	Called during async load to determine if PostLoad can be called on the loading thread.
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.