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

  • UTexture
  • UMediaTexture

References

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

Syntax

UCLASS (HideCategories=(Adjustments, Compositing, LevelOfDetail, ImportSettings, Object),  
       MinimalAPI)  
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 UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite assetregistrysearchable TEnumAsByte< TextureAddress > AddressX The addressing mode to use for the X axis.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite assetregistrysearchable TEnumAsByte< TextureAddress > AddressY The addressing mode to use for the Y axis.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool AutoClear Whether to clear the texture when no media is being played (default = enabled).
Public variable UProperty Category, EditAnywhere BlueprintReadWrite FLinearColor ClearColor The color used to clear the texture if AutoClear is enabled (default = black).
Public variable UProperty Category, Meta BlueprintReadOnly Transient skipserialization, textexporttransient PRAGMA_ENABLE_DEPRECATION_WARNINGS float CurrentAspectRatio Current aspect ratio
Public variable UProperty Category, Meta BlueprintReadOnly Transient skipserialization, textexporttransient TEnumAsByte< enum MediaTextureOrientation > CurrentOrientation Current media orientation
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly bool EnableGenMips Basic enablement for mip generation (default = false).
Protected variable UProperty Category, EditAnywhere TObjectPtr< UMediaPlayer > MediaPlayer The media player asset associated with this texture.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite bool NewStyleOutput Enable new style output.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite uint8 NumMips The number of mips to use (default = 1).

Constructors

  Type Name Description
Public function  

UMediaTexture ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual void  
Public function void

CacheNextAvailableSampleTime ( FTimespan InNextSampleTime
)

 Caches the next available sample time from the queue when last rendering was made
Public function Virtual Const uint32

CalcTextureMemorySizeEnum ( ETextureMipCount Enum
)

  
Public function Virtual FTextureResource *  
Public function Const UFunction BlueprintCallable, Category 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 Virtual FString

GetDesc ()

  
Public function Virtual Const FGuid  
Public function Const UFunction BlueprintCallable, Category int32 Gets the current height of the texture.
Public function Virtual Const EMaterialValueType  
Public function Const UFunction BlueprintCallable, Category 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 Virtual void

GetResourceSizeEx ( FResourceSizeEx& CumulativeResourceSize
)

  
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  
Public function Const UFunction BlueprintCallable, Category int32 Gets the current numbe of mips of the texture.
Public function Const UFunction BlueprintCallable, Category int32 Gets the current width of the texture.
Public function Virtual Const bool  
Public function Virtual void Renders this media texture.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

  
Public function Virtual void  
Public function Virtual void  
Public function void

SetColorSpaceOverride ( UE::Color::EColorSpace InColorspaceOverride
)

 Set an override for color space conversions
Public function void

SetDefaultMediaPlayer ( UMediaPlayer* NewMediaPlayer
)

 Set the texture's default media player property.
Public function UFunction BlueprintCallable, Category 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.
Public function Virtual UFunction BlueprintCallable, Category void Creates a new resource for the texture, and updates any cached references to the resource.
Protected function void

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

 Update sample info

Enums

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

Deprecated Variables

  Type Name Description
Public variable UProperty Meta PRAGMA_DISABLE_DEPRECATION_WARNINGS TEnumAsByte< enum MediaTextureOutputFormat > OutputFormat_DEPRECATED DEPRECATED 5.4

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page