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

> Unreal Engine API Reference > Plugins > BinkMediaPlayer > UBinkMediaTexture

Light Theme

Dark Theme

UBinkMediaTexture

Implements a texture asset for rendering video tracks from [UBinkMediaPlayer](API\Plugins\BinkMediaPlayer\UBinkMediaPlayer) assets.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UStreamableRenderAsset

UTexture

UBinkMediaTexture

References

Module	BinkMediaPlayer
Header	/Engine/Plugins/Media/BinkMedia/Source/BinkMediaPlayer/Public/BinkMediaTexture.h
Include	#include "BinkMediaTexture.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(HideCategories=(Compression, LevelOfDetail, Object))
class UBinkMediaTexture : public UTexture

Remarks

Implements a texture asset for rendering video tracks from UBinkMediaPlayer 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.
float	Alpha	Alpha_value is just a constant blend value for entire video frame.
FIntPoint	CachedDimensions
UBinkMediaPlaye...	CurrentMediaPlayer
bool	DecodeSRGB	Enable decoding of sRGB to Linear inside Bink when drawing to this texture.
UBinkMediaPlaye...	MediaPlayer	The MediaPlayer asset to stream video from.
float	OutputNits	When tonemapping, set this for to desired output nits capability for the current display.
TEnumAsByte< EP...	PixelFormat	The Pixel Format for the texture.
FRenderCommandF...	ReleasePlayerFence
bool	Tonemap	Whether to enable tonemaping for the video.

Constructors

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

Destructors

	Name	Description
	~UBinkMediaTexture()

Functions

	Name	Description
void	Clear()	Clears this texture to transparent-black.
void	HandleMediaPlayerMediaChanged()
void	InitializeTrack()
void	SetMediaPlayer ( UBinkMediaPlayer* InMediaPlaye... )	Sets the media player asset to be used for this texture.

Overridden from UTexture

	Name	Description
FTextureReso...	CreateResource()	Implemented by subclasses to create a new resource for the texture.
EMaterialVal...	GetMaterialType()
float	GetSurfaceHeight()
float	GetSurfaceWidth()

Overridden from UObject

	Name	Description
void	BeginDestroy()	Called before destroying the object.
void	FinishDestroy()	Called to finish destroying the object.
FString	GetDesc()	Return a one line description of an object for viewing in the thumbnail view of the generic browser
bool	IsReadyForFinishDestroy()	Called to check if the object is ready for FinishDestroy.
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.

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

Take our survey

Dismiss