Navigation
API > API/Plugins > API/Plugins/BinkMediaPlayer
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&40;HideCategories&61;&40;Compression, LevelOfDetail, Object&41;&41;
class UBinkMediaTexture : public UTexture
Remarks
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?
Variables
| Type | Name | Description | |
|---|---|---|---|
     |
TEnumAsByte< TextureAddress > | AddressX | The addressing mode to use for the X axis. |
     |
TEnumAsByte< TextureAddress > | 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 | |
 |
UBinkMediaPlayer * | CurrentMediaPlayer | |
    |
bool | DecodeSRGB | Enable decoding of sRGB to Linear inside Bink when drawing to this texture. |
    |
TObjectPtr< UBinkMediaPlayer > | 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< EPixelFormat > | PixelFormat | The Pixel Format for the texture. |
 |
FRenderCommandFence * | ReleasePlayerFence | |
    |
bool | Tonemap | Whether to enable tonemaping for the video. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
UBinkMediaTexture
(
const FObjectInitializer& ObjectInitializer |
Destructors
| Type | Name | Description | |
|---|---|---|---|
 |
Functions
| Type | Name | Description | |
|---|---|---|---|
   |
void | Clear () |
Clears this texture to transparent-black. |
 |
void | ||
 |
void | ||
   |
void | SetMediaPlayer
(
UBinkMediaPlayer* InMediaPlayer |
Sets the media player asset to be used for this texture. |
Overridden from UTexture
| Type | Name | Description | |
|---|---|---|---|
  |
FTextureResource * | Implemented by subclasses to create a new resource for the texture. | |
   |
EMaterialValueType | ||
   |
uint32 | ||
   |
float | ||
   |
float | ||
   |
float | ||
   |
ETextureClass | Get Texture Class |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
  |
void | BeginDestroy () |
Called before destroying the object. |
  |
void | 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 | Called to check if the object is ready for FinishDestroy. | |
  |
void | PostLoad () |
Do any object-specific cleanup required immediately after loading an object. |