Navigation
API > API/Plugins > API/Plugins/BinkMediaPlayer
Implements a texture asset for rendering video tracks from UBinkMediaPlayer assets.
note: derives directly from UTexture, not from UTexture2D or UTexture2DDynamic maybe should have been UTexture2DDynamic?
| Name | UBinkMediaTexture |
| Type | class |
| Header File | /Engine/Plugins/Media/BinkMedia/Source/BinkMediaPlayer/Public/BinkMediaTexture.h |
| Include Path | #include "BinkMediaTexture.h" |
Syntax
UCLASS (HideCategories=(Compression, LevelOfDetail, Object))
class UBinkMediaTexture : public UTexture
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UStreamableRenderAsset → UTexture → UBinkMediaTexture
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UBinkMediaTexture
(
const FObjectInitializer& ObjectInitializer |
BinkMediaTexture.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~UBinkMediaTexture() |
BinkMediaTexture.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AddressX | TEnumAsByte< TextureAddress > | The addressing mode to use for the X axis. | BinkMediaTexture.h |
|
| AddressY | TEnumAsByte< TextureAddress > | The addressing mode to use for the Y axis. | BinkMediaTexture.h |
|
| Alpha | float | Alpha_value is just a constant blend value for entire video frame. | BinkMediaTexture.h |
|
| CachedDimensions | FIntPoint | BinkMediaTexture.h | ||
| CurrentMediaPlayer | UBinkMediaPlayer * | BinkMediaTexture.h | ||
| DecodeSRGB | bool | Enable decoding of sRGB to Linear inside Bink when drawing to this texture. | BinkMediaTexture.h |
|
| MediaPlayer | TObjectPtr< UBinkMediaPlayer > | The MediaPlayer asset to stream video from. | BinkMediaTexture.h |
|
| OutputNits | float | When tonemapping, set this for to desired output nits capability for the current display. | BinkMediaTexture.h |
|
| PixelFormat | TEnumAsByte< EPixelFormat > | The Pixel Format for the texture. | BinkMediaTexture.h |
|
| ReleasePlayerFence | FRenderCommandFence * | BinkMediaTexture.h | ||
| Tonemap | bool | Whether to enable tonemaping for the video. | BinkMediaTexture.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Clear() |
Clears this texture to transparent-black. | BinkMediaTexture.h |
|
void HandleMediaPlayerMediaChanged() |
BinkMediaTexture.h | ||
void InitializeTrack() |
BinkMediaTexture.h | ||
void SetMediaPlayer
(
UBinkMediaPlayer* InMediaPlayer |
Sets the media player asset to be used for this texture. | BinkMediaTexture.h |
|
Overridden from UTexture
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FTextureResource * CreateResource() |
BinkMediaTexture.h | ||
virtual EMaterialValueType GetMaterialType() |
BinkMediaTexture.h | ||
virtual uint32 GetSurfaceArraySize() |
BinkMediaTexture.h | ||
virtual float GetSurfaceDepth() |
BinkMediaTexture.h | ||
virtual float GetSurfaceHeight() |
BinkMediaTexture.h | ||
virtual float GetSurfaceWidth() |
BinkMediaTexture.h | ||
virtual ETextureClass GetTextureClass() |
BinkMediaTexture.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BeginDestroy() |
BinkMediaTexture.h | ||
virtual void FinishDestroy() |
BinkMediaTexture.h | ||
virtual FString GetDesc() |
BinkMediaTexture.h | ||
virtual bool IsReadyForFinishDestroy() |
BinkMediaTexture.h | ||
virtual void PostLoad() |
BinkMediaTexture.h |