1. Epic GamesDeveloper
  3. UMediaTexture

UMediaTexture

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

API > API/Runtime > API/Runtime/MediaAssets

Inheritance Hierarchy

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.

note: derives directly from UTexture, not from UTexture2D or UTexture2DDynamic maybe should have been UTexture2DDynamic?

Variables

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

Constructors

  Type Name Description
Public function  

UMediaTexture ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function void Caches the next available sample time from the queue when last rendering was made
Public function Const float Gets the current aspect ratio of the texture.
Public function Const int32 Gets the number of samples that are available
Public function Const float Get current aspect ratio of presented frame.
Public function Const MediaTextureOrientation Get current orientation of presented frame.
Public function Const int32 Gets the current height of the texture.
Public function Const UMediaPlayer * Get the media player that provides the video samples.
Public function Const float Get the texture's mip-map bias, clamped to a legal range.
Public function Const FTimespan Gets the next sample Time.
Public function ERenderMode Returns the ERenderMode of this media texture
Public function Const int32 Gets the current numbe of mips of the texture.
Public function Const int32 Gets the current width of the texture.
Public function Virtual void Renders this media texture.
Public function void Set an override for color space conversions
Public function void

SetDefaultMediaPlayer ( UMediaPlayer* NewMediaPlayer
)

 Set the texture's default media player property.
Public function void

SetMediaPlayer ( UMediaPlayer* NewMediaPlayer
)

 Set the media player that provides the video samples.
Public function void

SetMipMapBias ( float InMipMapBias
)

 Set texture's mip-map bias, for use by the texture resource sampler.
Public function void

SetRenderedExternalTextureGuid ( const FGuid& InNewGuid
)

  
Public function void

SetRenderMode ( ERenderMode InRenderMode
)

 Sets the ERenderMode of this media texture
Protected function void

TickResource ( FTimespan Timecode
)

 Tick the texture resource.
Protected function void Update the video sample queue, if necessary.
Protected function void

UpdateSampleInfo ( const TSharedPtr< IMediaTextureSample, ESPMode::ThreadSafe >& Sample
)

 Update sample info

Overridden from UTexture

  Type Name Description
Public function Virtual Const uint32

CalcTextureMemorySizeEnum ( ETextureMipCount Enum
)

 Calculates the size of this texture if it had MipCount miplevels streamed in.
Public function Virtual FTextureResource * Implemented by subclasses to create a new resource for the texture.
Public function Virtual Const FGuid Access the GUID which defines this texture's resources externally through FExternalTextureRegistry
Public function Virtual Const EMaterialValueType  
Public function Virtual Const uint32  
Public function Virtual Const float  
Public function Virtual Const float  
Public function Virtual Const float  
Public function Virtual Const ETextureClass Get Texture Class
Public function Virtual void Creates a new resource for the texture, and updates any cached references to the resource.

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual FString

GetDesc ()

 Return a one line description of an object for viewing in the thumbnail view of the generic browser
Public function Virtual void

GetResourceSizeEx ( FResourceSizeEx& CumulativeResourceSize
)

 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).
Public function Virtual Const bool Called during async load to determine if PostLoad can be called on the loading thread.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.

Enums

  Type Name Description
Public enum ERenderMode Possible render modes of this media texture.  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page