UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UMediaTexture Class Reference

#include <MediaTexture.h>

+ Inheritance diagram for UMediaTexture:

Public Types

enum class  ERenderMode { Default = 0 , JustInTime }
 
- Public Types inherited from UTexture
enum class  EUpdateResourceFlags : uint32 { None =0 , ForceRebuild =0x1 , Synchronous =0x2 }
 
- Public Types inherited from UObject
enum class  ENetFields_Private { NETFIELD_REP_START = 0 , NETFIELD_REP_END = -1 }
 
typedef UObject WithinClass
 

Public Member Functions

MEDIAASSETS_API float GetAspectRatio () const
 
MEDIAASSETS_API int32 GetHeight () const
 
MEDIAASSETS_API int32 GetWidth () const
 
MEDIAASSETS_API int32 GetTextureNumMips () const
 
MEDIAASSETS_API UMediaPlayerGetMediaPlayer () const
 
MEDIAASSETS_API void SetMediaPlayer (UMediaPlayer *NewMediaPlayer)
 
MEDIAASSETS_API void SetMediaPlayer (UMediaPlayer *NewMediaPlayer, TSharedPtr< FMediaTextureSampleQueue > InSampleQueue)
 
void UpdateResource ()
 
MEDIAASSETS_API void CacheNextAvailableSampleTime (FTimespan InNextSampleTime)
 
MEDIAASSETS_API FTimespan GetNextSampleTime () const
 
MEDIAASSETS_API int32 GetAvailableSampleCount () const
 
MEDIAASSETS_API float GetCurrentAspectRatio () const
 
MEDIAASSETS_API MediaTextureOrientation GetCurrentOrientation () const
 
MEDIAASSETS_API float GetMipMapBias () const
 
MEDIAASSETS_API void SetMipMapBias (float InMipMapBias)
 
void SetColorSpaceOverride (UE::Color::EColorSpace InColorspaceOverride)
 
virtual MEDIAASSETS_API void JustInTimeRender ()
 
void SetRenderMode (ERenderMode InRenderMode)
 
ERenderMode GetRenderMode ()
 
virtual MEDIAASSETS_API void BeginDestroy () override
 
virtual MEDIAASSETS_API FTextureResourceCreateResource () override
 
virtual MEDIAASSETS_API EMaterialValueType GetMaterialType () const override
 
virtual MEDIAASSETS_API float GetSurfaceWidth () const override
 
virtual MEDIAASSETS_API float GetSurfaceHeight () const override
 
virtual float GetSurfaceDepth () const override
 
virtual uint32 GetSurfaceArraySize () const override
 
virtual MEDIAASSETS_API FGuid GetExternalTextureGuid () const override
 
MEDIAASSETS_API void SetRenderedExternalTextureGuid (const FGuid &InNewGuid)
 
virtual ETextureClass GetTextureClass () const override
 
virtual MEDIAASSETS_API uint32 CalcTextureMemorySizeEnum (ETextureMipCount Enum) const override
 
virtual MEDIAASSETS_API FString GetDesc () override
 
virtual MEDIAASSETS_API void GetResourceSizeEx (FResourceSizeEx &CumulativeResourceSize) override
 
virtual MEDIAASSETS_API void PostInitProperties () override
 
virtual MEDIAASSETS_API void PostLoad () override
 
virtual MEDIAASSETS_API bool IsPostLoadThreadSafe () const override
 
- Public Member Functions inherited from UTexture
virtual bool AreDownscalePropertiesEditable () const
 
int64 Blueprint_GetMemorySize () const
 
void Blueprint_GetTextureSourceDiskAndMemorySize (int64 &OutDiskSize, int64 &OutMemorySize) const
 
bool ComputeTextureSourceChannelMinMax (FLinearColor &OutColorMin, FLinearColor &OutColorMax) const
 
bool Blueprint_GetTextureSourceIdString (FString &OutTextureSourceId)
 
ENGINE_API UTexture (FVTableHelper &Helper)
 
virtual ENGINE_API ~UTexture ()
 
ENGINE_API void SetResource (FTextureResource *Resource)
 
ENGINE_API FTextureResourceGetResource ()
 
ENGINE_API const FTextureResourceGetResource () const
 
 DECLARE_MULTICAST_DELEGATE_OneParam (FOnTextureSaved, class UTexture *)
 
virtual ENGINE_API void ExportCustomProperties (FOutputDevice &Out, uint32 Indent) override
 
virtual ENGINE_API void ImportCustomProperties (const TCHAR *SourceText, FFeedbackContext *Warn) override
 
virtual ENGINE_API void PostEditImport () override
 
ENGINE_API void ReleaseResource ()
 
virtual ENGINE_API void UpdateResourceWithParams (EUpdateResourceFlags InFlags)
 
void UpdateCachedLODBias ()
 
int32 GetCachedLODBias () const override
 
ENGINE_API int32 CalculateLODBias (bool bWithCinematicMipBias) const
 
virtual bool IsCurrentlyVirtualTextured () const
 
ENGINE_API ETextureStreamingMethod GetTextureStreamingMethod () const
 
virtual ENGINE_API void GetVirtualTextureBuildSettings (struct FVirtualTextureBuildSettings &OutSettings) const
 
virtual FTexturePlatformData ** GetRunningPlatformData ()
 
virtual TMap< FString, FTexturePlatformData * > * GetCookedPlatformData ()
 
void CleanupCachedRunningPlatformData ()
 
ENGINE_API void GetBuiltTextureSize (const ITargetPlatform *TargetPlatform, int32 &OutSizeX, int32 &OutSizeY, int32 &OutSizeZ) const
 
ENGINE_API void GetBuiltTextureSize (const class ITargetPlatformSettings *TargetPlatformSettings, const class ITargetPlatformControls *TargetPlatformControls, int32 &OutSizeX, int32 &OutSizeY, int32 &OutSizeZ) const
 
void GetBuiltTextureSize (const ITargetPlatform *TargetPlatform, int32 &OutSizeX, int32 &OutSizeY) const
 
void GetBuiltTextureSize (const class ITargetPlatformSettings *TargetPlatformSettings, const class ITargetPlatformControls *TargetPlatformControls, int32 &OutSizeX, int32 &OutSizeY) const
 
FVector3f Blueprint_GetBuiltTextureSize ()
 
ENGINE_API void SerializeCookedPlatformData (class FArchive &Ar, const bool bSerializeMipData=true)
 
virtual ENGINE_API void AddAssetUserData (UAssetUserData *InUserData) override
 
virtual ENGINE_API void RemoveUserDataOfClass (TSubclassOf< UAssetUserData > InUserDataClass) override
 
virtual ENGINE_API UAssetUserDataGetAssetUserDataOfClass (TSubclassOf< UAssetUserData > InUserDataClass) override
 
virtual ENGINE_API const TArray< UAssetUserData * > * GetAssetUserDataArray () const override
 
EGammaSpace GetGammaSpace () const
 
virtual TextureAddress GetTextureAddressX () const
 
virtual TextureAddress GetTextureAddressY () const
 
virtual TextureAddress GetTextureAddressZ () const
 
virtual ENGINE_API void Serialize (FArchive &Ar) override
 
virtual ENGINE_API void PreSave (FObjectPreSaveContext ObjectSaveContext) override
 
virtual ENGINE_API bool IsReadyForFinishDestroy () override
 
virtual ENGINE_API void FinishDestroy () override
 
virtual ENGINE_API void PostCDOContruct () override
 
virtual int32 GetLODGroupForStreaming () const final override
 
virtual EStreamableRenderAssetType GetRenderAssetType () const final override
 
virtual ENGINE_API FIoFilenameHash GetMipIoFilenameHash (const int32 MipIndex) const final override
 
virtual ENGINE_API bool DoesMipDataExist (const int32 MipIndex) const final override
 
virtual ENGINE_API bool HasPendingRenderResourceInitialization () const final override
 
virtual ENGINE_API bool HasPendingLODTransition () const final override
 
virtual ENGINE_API void InvalidateLastRenderTimeForStreaming () final override
 
virtual ENGINE_API float GetLastRenderTimeForStreaming () const final override
 
virtual ENGINE_API bool ShouldMipLevelsBeForcedResident () const final override
 
virtual ENGINE_API float GetAverageBrightness (bool bIgnoreTrueBlack, bool bUseGrayscale)
 
bool HasHDRSource (int32 LayerIndex=0) const
 
bool IsNormalMap () const
 
bool IsUncompressed () const
 
ENGINE_API bool IsCookPlatformTilingDisabled (const ITargetPlatformSettings *TargetPlatformSettings) const
 
ENGINE_API bool IsCookPlatformTilingDisabled (const ITargetPlatform *TargetPlatform) const
 
const FGuidGetLightingGuid () const
 
void SetLightingGuid ()
 
void SetLightingGuid (const FGuid &Guid)
 
ENGINE_API void SetDeterministicLightingGuid ()
 
bool IsPossibleToStream () const
 
- Public Member Functions inherited from UStreamableRenderAsset
virtual ENGINE_API ~UStreamableRenderAsset ()
 
virtual int32 CalcCumulativeLODSize (int32 NumLODs) const
 
ENGINE_API void CancelPendingStreamingRequest ()
 
ENGINE_API bool HasPendingInitOrStreaming (bool bWaitForLODTransition=false) const
 
bool IsPendingStreamingRequestLocked () const
 
virtual bool StreamOut (int32 NewMipCount)
 
virtual bool StreamIn (int32 NewMipCount, bool bHighPrio)
 
ENGINE_API void RegisterMipLevelChangeCallback (UPrimitiveComponent *Component, int32 LODIdx, float TimeoutSecs, bool bOnStreamIn, FLODStreamingCallback &&Callback)
 
ENGINE_API void RegisterMipLevelChangeCallback (UPrimitiveComponent *Component, float TimeoutStartSecs, FLODStreamingCallback &&CallbackStreamingStart, float TimeoutDoneSecs, FLODStreamingCallback &&CallbackStreamingDone)
 
ENGINE_API void RemoveMipLevelChangeCallback (UPrimitiveComponent *Component)
 
ENGINE_API void RemoveAllMipLevelChangeCallbacks ()
 
ENGINE_API void TickMipLevelChangeCallbacks (TArray< UStreamableRenderAsset * > *DeferredTickCBAssets)
 
ENGINE_API void SetForceMipLevelsToBeResident (float Seconds, int32 CinematicLODGroupMask=0)
 
const FStreamableRenderResourceStateGetStreamableResourceState () const
 
bool RenderResourceSupportsStreaming () const
 
bool IsStreamable () const
 
ENGINE_API void LinkStreaming ()
 
ENGINE_API void UnlinkStreaming ()
 
ENGINE_API bool IsFullyStreamedIn ()
 
int32 GetStreamingIndex () const
 
ENGINE_API void WaitForPendingInitOrStreaming (bool bWaitForLODTransition=false, bool bSendCompletionEvents=false)
 
ENGINE_API void WaitForStreaming (bool bWaitForLODTransition=false, bool bSendCompletionEvents=false)
 
void TickStreaming (bool bSendCompletionEvents=false, TArray< UStreamableRenderAsset * > *DeferredTickCBAssets=nullptr)
 
const FPerQualityLevelIntGetNoRefStreamingLODBias () const
 
void SetNoRefStreamingLODBias (FPerQualityLevelInt NewValue)
 
ENGINE_API int32 GetCurrentNoRefStreamingLODBias () const
 
- Public Member Functions inherited from UObject
COREUOBJECT_API UObject ()
 
COREUOBJECT_API UObject (const FObjectInitializer &ObjectInitializer)
 
COREUOBJECT_API UObject (EStaticConstructor, EObjectFlags InFlags)
 
COREUOBJECT_API UObject (FVTableHelper &Helper)
 
COREUOBJECT_API UObjectCreateDefaultSubobject (FName SubobjectFName, UClass *ReturnType, UClass *ClassToCreateByDefault, bool bIsRequired, bool bIsTransient)
 
template<class TReturnType >
TReturnTypeCreateEditorOnlyDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType >
TReturnTypeCreateDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType , class TClassToConstructByDefault >
TReturnTypeCreateDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType >
TReturnTypeCreateOptionalDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType , class TClassToConstructByDefault >
TReturnTypeCreateOptionalDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
COREUOBJECT_API void GetDefaultSubobjects (TArray< UObject * > &OutDefaultSubobjects)
 
COREUOBJECT_API UObjectGetDefaultSubobjectByName (FName ToFind)
 
virtual COREUOBJECT_API void PostReinitProperties ()
 
virtual COREUOBJECT_API void PreSaveRoot (FObjectPreSaveRootContext ObjectSaveContext)
 
virtual COREUOBJECT_API void PostSaveRoot (FObjectPostSaveRootContext ObjectSaveContext)
 
virtual COREUOBJECT_API void CollectSaveOverrides (FObjectCollectSaveOverridesContext SaveContext)
 
UE_FORCEINLINE_HINT bool Modify (bool bAlwaysMarkDirty=true)
 
UE_FORCEINLINE_HINT bool IsCapturingAsRootObjectForTransaction () const
 
virtual bool ResolveSubobject (const TCHAR *SubObjectPath, UObject *&OutObject, bool bLoadIfExists)
 
virtual bool IsReadyForAsyncPostLoad () const
 
virtual COREUOBJECT_API void PostLoadSubobjects (FObjectInstancingGraph *OuterInstanceGraph)
 
virtual COREUOBJECT_API void Serialize (FStructuredArchive::FRecord Record)
 
virtual void ShutdownAfterError ()
 
virtual void PostInterpChange (FProperty *PropertyThatChanged)
 
virtual COREUOBJECT_API void PostRename (UObject *OldOuter, const FName OldName)
 
virtual void PreDuplicate (FObjectDuplicationParameters &DupParams)
 
virtual void PostDuplicate (bool bDuplicateForPIE)
 
virtual void PostDuplicate (EDuplicateMode::Type DuplicateMode)
 
virtual COREUOBJECT_API bool NeedsLoadForClient () const
 
virtual COREUOBJECT_API bool NeedsLoadForServer () const
 
virtual COREUOBJECT_API bool NeedsLoadForTargetPlatform (const class ITargetPlatform *TargetPlatform) const
 
virtual bool NeedsLoadForEditorGame () const
 
virtual bool IsEditorOnly () const
 
virtual bool HasNonEditorOnlyReferences () const
 
virtual COREUOBJECT_API bool IsDestructionThreadSafe () const
 
virtual COREUOBJECT_API void GetPreloadDependencies (TArray< UObject * > &OutDeps)
 
virtual void GetPrestreamPackages (TArray< UObject * > &OutPrestream)
 
virtual void PostReloadConfig (class FProperty *PropertyThatWasLoaded)
 
virtual COREUOBJECT_API bool Rename (const TCHAR *NewName=nullptr, UObject *NewOuter=nullptr, ERenameFlags Flags=REN_None)
 
COREUOBJECT_API UScriptStructGetSparseClassDataStruct () const
 
virtual bool GetNativePropertyValues (TMap< FString, FString > &out_PropertyValues, uint32 ExportFlags=0) const
 
SIZE_T GetResourceSizeBytes (EResourceSizeMode::Type Mode)
 
virtual FName GetExporterName (void)
 
COREUOBJECT_API void CallAddReferencedObjects (FReferenceCollector &Collector)
 
virtual FRestoreForUObjectOverwriteGetRestoreForUObjectOverwrite ()
 
virtual bool AreNativePropertiesIdenticalTo (UObject *Other) const
 
virtual COREUOBJECT_API void GetAssetRegistryTags (FAssetRegistryTagsContext Context) const
 
virtual COREUOBJECT_API void GetAssetRegistryTags (TArray< FAssetRegistryTag > &OutTags) const
 
COREUOBJECT_API void GetAssetRegistryTags (FAssetData &Out) const
 
COREUOBJECT_API void GetAssetRegistryTags (FAssetRegistryTagsContext Context, FAssetData &Out) const
 
virtual COREUOBJECT_API bool IsAsset () const
 
virtual COREUOBJECT_API FPrimaryAssetId GetPrimaryAssetId () const
 
virtual COREUOBJECT_API bool IsLocalizedResource () const
 
virtual COREUOBJECT_API bool IsSafeForRootSet () const
 
virtual COREUOBJECT_API void TagSubobjects (EObjectFlags NewFlags)
 
virtual COREUOBJECT_API void GetLifetimeReplicatedProps (TArray< class FLifetimeProperty > &OutLifetimeProps) const
 
virtual COREUOBJECT_API void GetReplicatedCustomConditionState (FCustomPropertyConditionState &OutActiveState) const
 
virtual COREUOBJECT_API void RegisterReplicationFragments (UE::Net::FFragmentRegistrationContext &Context, UE::Net::EFragmentRegistrationFlags RegistrationFlags)
 
virtual COREUOBJECT_API bool IsNameStableForNetworking () const
 
virtual COREUOBJECT_API bool IsFullNameStableForNetworking () const
 
virtual COREUOBJECT_API bool IsSupportedForNetworking () const
 
virtual void GetSubobjectsWithStableNamesForNetworking (TArray< UObject * > &ObjList)
 
virtual COREUOBJECT_API void PreNetReceive ()
 
virtual COREUOBJECT_API void PostNetReceive ()
 
virtual void PostRepNotifies ()
 
virtual COREUOBJECT_API void PreDestroyFromReplication ()
 
COREUOBJECT_API bool IsSelected () const
 
COREUOBJECT_API void SerializeScriptProperties (FArchive &Ar) const
 
COREUOBJECT_API void SerializeScriptProperties (FStructuredArchive::FSlot Slot) const
 
COREUOBJECT_API void ReinitializeProperties (UObject *SourceObject=NULL, struct FObjectInstancingGraph *InstanceGraph=NULL)
 
COREUOBJECT_API FString GetDetailedInfo () const
 
COREUOBJECT_API bool ConditionalBeginDestroy ()
 
COREUOBJECT_API bool ConditionalFinishDestroy ()
 
COREUOBJECT_API void ConditionalPostLoad ()
 
COREUOBJECT_API void ConditionalPreload ()
 
COREUOBJECT_API void ConditionalPostLoadSubobjects (struct FObjectInstancingGraph *OuterInstanceGraph=NULL)
 
bool IsBasedOnArchetype (const UObject *const SomeObject) const
 
COREUOBJECT_API UFunctionFindFunction (FName InName) const
 
COREUOBJECT_API UFunctionFindFunctionChecked (FName InName) const
 
virtual COREUOBJECT_API void BuildSubobjectMapping (UObject *OtherObject, TMap< UObject *, UObject * > &ObjectMapping) const
 
COREUOBJECT_API void CollectDefaultSubobjects (TArray< UObject * > &OutDefaultSubobjects, bool bIncludeNestedSubobjects=false) const
 
COREUOBJECT_API bool CheckDefaultSubobjects (bool bForceCheck=false) const
 
COREUOBJECT_API void SaveConfig (uint64 RequiredPropertyFlags=CPF_Config, const TCHAR *Filename=nullptr, FConfigCacheIni *Config=GConfig, bool bAllowCopyToDefaultObject=true)
 
COREUOBJECT_API void SaveConfig (const FSaveConfigContext &Context)
 
COREUOBJECT_API void UpdateDefaultConfigFile (const FString &SpecificFileLocation="")
 
COREUOBJECT_API bool TryUpdateDefaultConfigFile (const FString &SpecificFileLocation="", bool bWarnIfFail=true)
 
COREUOBJECT_API void UpdateGlobalUserConfigFile ()
 
COREUOBJECT_API void UpdateProjectUserConfigFile ()
 
COREUOBJECT_API void UpdateSinglePropertyInConfigFile (const FProperty *InProperty, const FString &InConfigIniName)
 
COREUOBJECT_API FString GetDefaultConfigFilename () const
 
COREUOBJECT_API FString GetGlobalUserConfigFilename () const
 
COREUOBJECT_API FString GetProjectUserConfigFilename () const
 
virtual const TCHARGetConfigOverridePlatform () const
 
virtual void OverrideConfigSection (FString &SectionName)
 
virtual void OverridePerObjectConfigSection (FString &SectionName)
 
COREUOBJECT_API void LoadConfig (UClass *ConfigClass=nullptr, const TCHAR *Filename=nullptr, uint32 PropagationFlags=UE::LCPF_None, class FProperty *PropertyToLoad=nullptr, TArray< UE::ConfigAccessTracking::FConfigAccessData > *OutAccessedKeys=nullptr)
 
COREUOBJECT_API void ReloadConfig (UClass *ConfigClass=NULL, const TCHAR *Filename=NULL, uint32 PropagationFlags=UE::LCPF_None, class FProperty *PropertyToLoad=NULL)
 
COREUOBJECT_API void ParseParms (const TCHAR *Parms)
 
COREUOBJECT_API void OutputReferencers (FOutputDevice &Ar, FReferencerInformationList *Referencers=NULL)
 
COREUOBJECT_API void RetrieveReferencers (TArray< FReferencerInformation > *OutInternalReferencers, TArray< FReferencerInformation > *OutExternalReferencers)
 
COREUOBJECT_API void SetLinker (FLinkerLoad *LinkerLoad, int32 LinkerIndex, bool bShouldDetachExisting=true, bool bSilenceLogs=false)
 
COREUOBJECT_API UObjectGetArchetype () const
 
COREUOBJECT_API void GetArchetypeInstances (TArray< UObject * > &Instances)
 
COREUOBJECT_API void InstanceSubobjectTemplates (struct FObjectInstancingGraph *InstanceGraph=NULL)
 
template<class T >
bool Implements () const
 
virtual COREUOBJECT_API void ProcessEvent (UFunction *Function, void *Parms)
 
virtual int32 GetFunctionCallspace (UFunction *Function, FFrame *Stack)
 
virtual bool CallRemoteFunction (UFunction *Function, void *Parms, struct FOutParmRec *OutParms, FFrame *Stack)
 
COREUOBJECT_API bool CallFunctionByNameWithArguments (const TCHAR *Cmd, FOutputDevice &Ar, UObject *Executor, bool bForceCallWithNonExec=false)
 
COREUOBJECT_API void CallFunction (FFrame &Stack, RESULT_DECL, UFunction *Function)
 
 DECLARE_FUNCTION (ProcessInternal)
 
virtual bool ProcessConsoleExec (const TCHAR *Cmd, FOutputDevice &Ar, UObject *Executor)
 
COREUOBJECT_API void SkipFunction (FFrame &Stack, RESULT_DECL, UFunction *Function)
 
virtual UClassRegenerateClass (UClass *ClassToRegenerate, UObject *PreviousCDO)
 
COREUOBJECT_API bool IsInBlueprint () const
 
COREUOBJECT_API void DestroyNonNativeProperties ()
 
virtual void MarkAsEditorOnlySubobject ()
 
COREUOBJECT_API void AbortInsideMemberFunction () const
 
 DECLARE_FUNCTION (execUndefined)
 
 DECLARE_FUNCTION (execLocalVariable)
 
 DECLARE_FUNCTION (execInstanceVariable)
 
 DECLARE_FUNCTION (execDefaultVariable)
 
 DECLARE_FUNCTION (execLocalOutVariable)
 
 DECLARE_FUNCTION (execInterfaceVariable)
 
 DECLARE_FUNCTION (execClassSparseDataVariable)
 
 DECLARE_FUNCTION (execInterfaceContext)
 
 DECLARE_FUNCTION (execArrayElement)
 
 DECLARE_FUNCTION (execBoolVariable)
 
 DECLARE_FUNCTION (execClassDefaultVariable)
 
 DECLARE_FUNCTION (execEndFunctionParms)
 
 DECLARE_FUNCTION (execNothing)
 
 DECLARE_FUNCTION (execNothingInt32)
 
 DECLARE_FUNCTION (execNothingOp4a)
 
 DECLARE_FUNCTION (execBreakpoint)
 
 DECLARE_FUNCTION (execTracepoint)
 
 DECLARE_FUNCTION (execWireTracepoint)
 
 DECLARE_FUNCTION (execInstrumentation)
 
 DECLARE_FUNCTION (execEndOfScript)
 
 DECLARE_FUNCTION (execReturnNothing)
 
 DECLARE_FUNCTION (execEmptyParmValue)
 
 DECLARE_FUNCTION (execJump)
 
 DECLARE_FUNCTION (execJumpIfNot)
 
 DECLARE_FUNCTION (execAssert)
 
 DECLARE_FUNCTION (execPushExecutionFlow)
 
 DECLARE_FUNCTION (execPopExecutionFlow)
 
 DECLARE_FUNCTION (execComputedJump)
 
 DECLARE_FUNCTION (execPopExecutionFlowIfNot)
 
 DECLARE_FUNCTION (execLet)
 
 DECLARE_FUNCTION (execLetObj)
 
 DECLARE_FUNCTION (execLetWeakObjPtr)
 
 DECLARE_FUNCTION (execLetBool)
 
 DECLARE_FUNCTION (execLetDelegate)
 
 DECLARE_FUNCTION (execLetMulticastDelegate)
 
 DECLARE_FUNCTION (execAddMulticastDelegate)
 
 DECLARE_FUNCTION (execClearMulticastDelegate)
 
 DECLARE_FUNCTION (execEatReturnValue)
 
 DECLARE_FUNCTION (execRemoveMulticastDelegate)
 
 DECLARE_FUNCTION (execSelf)
 
 DECLARE_FUNCTION (execContext)
 
 DECLARE_FUNCTION (execContext_FailSilent)
 
 DECLARE_FUNCTION (execStructMemberContext)
 
 DECLARE_FUNCTION (execVirtualFunction)
 
 DECLARE_FUNCTION (execFinalFunction)
 
 DECLARE_FUNCTION (execLocalVirtualFunction)
 
 DECLARE_FUNCTION (execLocalFinalFunction)
 
 DECLARE_FUNCTION (execStructCmpEq)
 
 DECLARE_FUNCTION (execStructCmpNe)
 
 DECLARE_FUNCTION (execStructMember)
 
 DECLARE_FUNCTION (execEqualEqual_DelegateDelegate)
 
 DECLARE_FUNCTION (execNotEqual_DelegateDelegate)
 
 DECLARE_FUNCTION (execEqualEqual_DelegateFunction)
 
 DECLARE_FUNCTION (execNotEqual_DelegateFunction)
 
 DECLARE_FUNCTION (execIntConst)
 
 DECLARE_FUNCTION (execInt64Const)
 
 DECLARE_FUNCTION (execUInt64Const)
 
 DECLARE_FUNCTION (execSkipOffsetConst)
 
 DECLARE_FUNCTION (execFloatConst)
 
 DECLARE_FUNCTION (execDoubleConst)
 
 DECLARE_FUNCTION (execStringConst)
 
 DECLARE_FUNCTION (execUnicodeStringConst)
 
 DECLARE_FUNCTION (execTextConst)
 
 DECLARE_FUNCTION (execPropertyConst)
 
 DECLARE_FUNCTION (execObjectConst)
 
 DECLARE_FUNCTION (execSoftObjectConst)
 
 DECLARE_FUNCTION (execFieldPathConst)
 
 DECLARE_FUNCTION (execInstanceDelegate)
 
 DECLARE_FUNCTION (execNameConst)
 
 DECLARE_FUNCTION (execByteConst)
 
 DECLARE_FUNCTION (execIntZero)
 
 DECLARE_FUNCTION (execIntOne)
 
 DECLARE_FUNCTION (execTrue)
 
 DECLARE_FUNCTION (execFalse)
 
 DECLARE_FUNCTION (execNoObject)
 
 DECLARE_FUNCTION (execNullInterface)
 
 DECLARE_FUNCTION (execIntConstByte)
 
 DECLARE_FUNCTION (execRotationConst)
 
 DECLARE_FUNCTION (execVectorConst)
 
 DECLARE_FUNCTION (execVector3fConst)
 
 DECLARE_FUNCTION (execTransformConst)
 
 DECLARE_FUNCTION (execStructConst)
 
 DECLARE_FUNCTION (execSetArray)
 
 DECLARE_FUNCTION (execSetSet)
 
 DECLARE_FUNCTION (execSetMap)
 
 DECLARE_FUNCTION (execArrayConst)
 
 DECLARE_FUNCTION (execSetConst)
 
 DECLARE_FUNCTION (execMapConst)
 
 DECLARE_FUNCTION (execBitFieldConst)
 
 DECLARE_FUNCTION (execNew)
 
 DECLARE_FUNCTION (execClassContext)
 
 DECLARE_FUNCTION (execNativeParm)
 
 DECLARE_FUNCTION (execCast)
 
 DECLARE_FUNCTION (execDynamicCast)
 
 DECLARE_FUNCTION (execMetaCast)
 
 DECLARE_FUNCTION (execInterfaceCast)
 
 DECLARE_FUNCTION (execDoubleToFloatCast)
 
 DECLARE_FUNCTION (execFloatToDoubleCast)
 
 DECLARE_FUNCTION (execObjectToBool)
 
 DECLARE_FUNCTION (execInterfaceToBool)
 
 DECLARE_FUNCTION (execObjectToInterface)
 
 DECLARE_FUNCTION (execInterfaceToInterface)
 
 DECLARE_FUNCTION (execInterfaceToObject)
 
 DECLARE_FUNCTION (execGetDynArrayElement)
 
 DECLARE_FUNCTION (execSetDynArrayElement)
 
 DECLARE_FUNCTION (execGetDynArrayLength)
 
 DECLARE_FUNCTION (execSetDynArrayLength)
 
 DECLARE_FUNCTION (execDynArrayInsert)
 
 DECLARE_FUNCTION (execDynArrayRemove)
 
 DECLARE_FUNCTION (execDynArrayFind)
 
 DECLARE_FUNCTION (execDynArrayFindStruct)
 
 DECLARE_FUNCTION (execDynArrayAdd)
 
 DECLARE_FUNCTION (execDynArrayAddItem)
 
 DECLARE_FUNCTION (execDynArrayInsertItem)
 
 DECLARE_FUNCTION (execDynArrayRemoveItem)
 
 DECLARE_FUNCTION (execDynArraySort)
 
 DECLARE_FUNCTION (execBindDelegate)
 
 DECLARE_FUNCTION (execCallMulticastDelegate)
 
 DECLARE_FUNCTION (execLetValueOnPersistentFrame)
 
 DECLARE_FUNCTION (execCallMathFunction)
 
 DECLARE_FUNCTION (execSwitchValue)
 
 DECLARE_FUNCTION (execArrayGetByRef)
 
 DECLARE_FUNCTION (execAutoRtfmTransact)
 
 DECLARE_FUNCTION (execAutoRtfmStopTransact)
 
 DECLARE_FUNCTION (execAutoRtfmAbortIfNot)
 
void ExecuteUbergraph (int32 EntryPoint)
 
virtual void ValidateGeneratedRepEnums (const TArray< struct FRepRecord > &ClassReps) const
 
virtual uint64 GetNetPushIdDynamic () const
 
- Public Member Functions inherited from UObjectBaseUtility
 UObjectBaseUtility ()
 
 UObjectBaseUtility (EObjectFlags InFlags)
 
void SetFlags (EObjectFlags NewFlags)
 
void ClearFlags (EObjectFlags FlagsToClear)
 
bool HasAnyFlags (EObjectFlags FlagsToCheck) const
 
bool HasAllFlags (EObjectFlags FlagsToCheck) const
 
UE_FORCEINLINE_HINT EObjectFlags GetMaskedFlags (EObjectFlags Mask=RF_AllFlags) const
 
UE_FORCEINLINE_HINT void Mark (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT void UnMark (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT bool HasAnyMarks (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT bool HasAllMarks (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT EObjectMark GetAllMarks () const
 
void MarkAsGarbage ()
 
void ClearGarbage ()
 
UE_FORCEINLINE_HINT void AddToRoot ()
 
UE_FORCEINLINE_HINT void RemoveFromRoot ()
 
UE_FORCEINLINE_HINT bool IsRooted () const
 
UE_FORCEINLINE_HINT int32 GetRefCount () const
 
bool ThisThreadAtomicallyClearedRFUnreachable ()
 
UE_FORCEINLINE_HINT bool IsUnreachable () const
 
UE_FORCEINLINE_HINT bool IsNative () const
 
void SetInternalFlags (EInternalObjectFlags FlagsToSet) const
 
UE_FORCEINLINE_HINT EInternalObjectFlags GetInternalFlags () const
 
UE_FORCEINLINE_HINT bool HasAnyInternalFlags (EInternalObjectFlags FlagsToCheck) const
 
void ClearInternalFlags (EInternalObjectFlags FlagsToClear) const
 
bool AtomicallyClearInternalFlags (EInternalObjectFlags FlagsToClear) const
 
COREUOBJECT_API FString GetFullName (const UObject *StopOuter=NULL, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API void GetFullName (const UObject *StopOuter, FString &ResultString, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API void GetFullName (FStringBuilderBase &ResultString, const UObject *StopOuter=NULL, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API FString GetPathName (const UObject *StopOuter=NULL) const
 
COREUOBJECT_API void GetPathName (const UObject *StopOuter, FString &ResultString) const
 
COREUOBJECT_API void GetPathName (const UObject *StopOuter, FStringBuilderBase &ResultString) const
 
virtual bool CanBeClusterRoot () const
 
virtual COREUOBJECT_API bool CanBeInCluster () const
 
virtual COREUOBJECT_API void CreateCluster ()
 
virtual void OnClusterMarkedAsPendingKill ()
 
COREUOBJECT_API void AddToCluster (UObjectBaseUtility *ClusterRootOrObjectFromCluster, bool bAddAsMutableObject=false)
 
COREUOBJECT_API FString GetFullGroupName (bool bStartWithOuter) const
 
UE_FORCEINLINE_HINT FString GetName () const
 
UE_FORCEINLINE_HINT void GetName (FString &ResultString) const
 
UE_FORCEINLINE_HINT void AppendName (FString &ResultString) const
 
COREUOBJECT_API bool IsPackageExternal () const
 
COREUOBJECT_API void DetachExternalPackage ()
 
COREUOBJECT_API void ReattachExternalPackage ()
 
COREUOBJECT_API UObjectGetOutermostObject () const
 
COREUOBJECT_API UPackageGetPackage () const
 
UE_INTERNAL virtual COREUOBJECT_API UE::Core::FVersePath GetVersePath () const
 
COREUOBJECT_API UPackageGetOutermost () const
 
COREUOBJECT_API bool MarkPackageDirty () const
 
COREUOBJECT_API bool IsTemplate (EObjectFlags TemplateTypes=RF_ArchetypeObject|RF_ClassDefaultObject) const
 
COREUOBJECT_API UObjectGetTypedOuter (UClass *Target) const
 
template<typename T >
T * GetTypedOuter () const
 
template<typename InterfaceClassType >
InterfaceClassTypeGetImplementingOuter () const
 
COREUOBJECT_API UObjectBaseUtilityGetImplementingOuterObject (const UClass *InInterfaceClass) const
 
COREUOBJECT_API bool IsIn (const UObject *SomeOuter) const
 
COREUOBJECT_API bool IsIn (const UPackage *SomePackage) const
 
COREUOBJECT_API bool IsInOuter (const UObject *SomeOuter) const
 
COREUOBJECT_API bool IsInPackage (const UPackage *SomePackage) const
 
COREUOBJECT_API bool IsInA (const UClass *SomeBaseClass) const
 
COREUOBJECT_API bool RootPackageHasAnyFlags (uint32 CheckFlagMask) const
 
template<typename OtherClassType >
bool IsA (OtherClassType SomeBase) const
 
template<class T >
bool IsA () const
 
COREUOBJECT_API const UClassFindNearestCommonBaseClass (const UClass *TestClass) const
 
COREUOBJECT_API voidGetInterfaceAddress (UClass *InterfaceClass)
 
COREUOBJECT_API voidGetNativeInterfaceAddress (UClass *InterfaceClass)
 
const voidGetNativeInterfaceAddress (UClass *InterfaceClass) const
 
COREUOBJECT_API bool IsTemplateForSubobjects (EObjectFlags TemplateTypes=RF_ClassDefaultObject|RF_DefaultSubObject|RF_InheritableComponentTemplate) const
 
COREUOBJECT_API bool IsDefaultSubobject () const
 
COREUOBJECT_API class FLinkerLoadGetLinker () const
 
COREUOBJECT_API int32 GetLinkerIndex () const
 
COREUOBJECT_API FPackageFileVersion GetLinkerUEVersion () const
 
int32 GetLinkerUE4Version () const
 
COREUOBJECT_API int32 GetLinkerLicenseeUEVersion () const
 
int32 GetLinkerLicenseeUE4Version () const
 
COREUOBJECT_API int32 GetLinkerCustomVersion (FGuid CustomVersionKey) const
 
UE_FORCEINLINE_HINT bool operator< (const UObjectBaseUtility &Other) const
 
TStatId GetStatID (bool bForDeferredUse=false) const
 
- Public Member Functions inherited from UObjectBase
COREUOBJECT_API UObjectBase (UClass *InClass, EObjectFlags InFlags, EInternalObjectFlags InInternalFlags, UObject *InOuter, FName InName, int32 InInternalIndex=-1, int32 InSerialNumber=0, FRemoteObjectId InRemoteId=FRemoteObjectId())
 
virtual COREUOBJECT_API ~UObjectBase ()
 
COREUOBJECT_API bool IsValidLowLevel () const
 
COREUOBJECT_API bool IsValidLowLevelFast (bool bRecursive=true) const
 
FORCEINLINE uint32 GetUniqueID () const
 
FORCEINLINE UClassGetClass () const
 
FORCEINLINE UObjectGetOuter () const
 
FORCEINLINE FName GetFName () const
 
virtual COREUOBJECT_API FName GetFNameForStatID () const
 
COREUOBJECT_API UPackageGetExternalPackage () const
 
COREUOBJECT_API void SetExternalPackage (UPackage *InPackage)
 
COREUOBJECT_API UPackageGetExternalPackageInternal () const
 
COREUOBJECT_API void MarkAsReachable () const
 
COREUOBJECT_API void AddRef () const
 
COREUOBJECT_API void ReleaseRef () const
 
FORCEINLINE EObjectFlags GetFlags () const
 
FORCENOINLINE void AtomicallySetFlags (EObjectFlags FlagsToAdd)
 
FORCENOINLINE void AtomicallyClearFlags (EObjectFlags FlagsToClear)
 

Public Attributes

TEnumAsByte< TextureAddressAddressX
 
TEnumAsByte< TextureAddressAddressY
 
bool AutoClear
 
FLinearColor ClearColor
 
bool EnableGenMips
 
bool NewStyleOutput
 
float CurrentAspectRatio
 
TEnumAsByte< enum MediaTextureOrientationCurrentOrientation
 
- Public Attributes inherited from UTexture
int32 LevelIndex = INDEX_NONE
 
int32 LODBias
 
TEnumAsByte< enum TextureCompressionSettingsCompressionSettings
 
TEnumAsByte< enum TextureFilterFilter
 
ETextureMipLoadOptions MipLoadOptions
 
EVTProducerPriority VirtualTextureStreamingPriority
 
uint8 VirtualTexturePrefetchMips = 0
 
TEnumAsByte< enum TextureCookPlatformTilingSettingsCookPlatformTilingSettings
 
bool bOodlePreserveExtremes = false
 
TEnumAsByte< enum TextureGroupLODGroup
 
FPerPlatformFloat Downscale
 
ETextureDownscaleOptions DownscaleOptions
 
ETextureAvailability Availability
 
uint8 SRGB:1
 
uint8 bNoTiling:1
 
uint8 VirtualTextureStreaming: 1
 
uint32 bUseVirtualTextureStreamingPriority: 1
 
uint8 CompressionYCoCg: 1
 
uint8 bNotOfflineProcessed: 1
 
FTextureReferenceTextureReference
 
FRenderCommandFence ReleaseFence
 
virtual ETextureClass GetTextureClass () const PURE_VIRTUAL(UTexture
 
virtual class FTextureResourceCreateResource () PURE_VIRTUAL(UTexture
 
virtual EMaterialValueType GetMaterialType () const PURE_VIRTUAL(UTexture
 
virtual float GetSurfaceWidth () const PURE_VIRTUAL(UTexture
 
virtual float GetSurfaceHeight () const PURE_VIRTUAL(UTexture
 
virtual float GetSurfaceDepth () const PURE_VIRTUAL(UTexture
 
virtual uint32 GetSurfaceArraySize () const PURE_VIRTUAL(UTexture
 
- Public Attributes inherited from UStreamableRenderAsset
int32 NumCinematicMipLevels
 
uint8 NeverStream: 1
 
uint8 bGlobalForceMipLevelsToBeResident: 1
 
uint8 bHasStreamingUpdatePending: 1
 
uint8 bForceMiplevelsToBeResident: 1
 
uint8 bIgnoreStreamingMipBias: 1
 
uint8 bMarkAsEditorStreamingPool: 1
 

Protected Member Functions

MEDIAASSETS_API void TickResource (FTimespan Timecode)
 
MEDIAASSETS_API void UpdatePlayerAndQueue (TSharedPtr< FMediaTextureSampleQueue > InSampleQueue=nullptr)
 
MEDIAASSETS_API void UpdateSampleInfo (const TSharedPtr< IMediaTextureSample, ESPMode::ThreadSafe > &Sample)
 
- Protected Member Functions inherited from UTexture
void BeginFinalReleaseResource ()
 
FStreamableRenderResourceState GetResourcePostInitState (const FTexturePlatformData *PlatformData, bool bAllowStreaming, int32 MinRequestMipCount=0, int32 MaxMipCount=0, bool bSkipCanBeLoaded=false) const
 
- Protected Member Functions inherited from UObject
virtual FString GetDetailedInfoInternal () const
 
COREUOBJECT_API bool CanCheckDefaultSubObjects (bool bForceCheck, bool &bResult) const
 
virtual COREUOBJECT_API bool CheckDefaultSubobjectsInternal () const
 
- Protected Member Functions inherited from UObjectBase
 UObjectBase ()
 
COREUOBJECT_API UObjectBase (EObjectFlags InFlags)
 
COREUOBJECT_API void LowLevelRename (FName NewName, UObject *NewOuter=NULL)
 
virtual void RegisterDependencies ()
 
COREUOBJECT_API void Register (class UClass *(*StaticClassFn)(), const TCHAR *PackageName, const TCHAR *Name)
 
COREUOBJECT_API void Register (const TCHAR *PackageName, const TCHAR *Name)
 
virtual COREUOBJECT_API void DeferredRegister (UClass *UClassStaticClass, const TCHAR *PackageName, const TCHAR *Name)
 
FORCEINLINE void SetFlagsTo (EObjectFlags NewFlags)
 

Protected Attributes

TObjectPtr< UMediaPlayerMediaPlayer
 
- Protected Attributes inherited from UTexture
TArray< TObjectPtr< UAssetUserData > > AssetUserData
 
- Protected Attributes inherited from UStreamableRenderAsset
TArray< FLODStreamingCallbackPayloadMipChangeCallbacks
 
TRefCountPtr< class FRenderAssetUpdatePendingUpdate
 
double ForceMipLevelsToBeResidentTimestamp
 
FPerQualityLevelInt NoRefStreamingLODBias
 
int32 StreamingIndex = INDEX_NONE
 
TSharedPtr< int32, ESPMode::ThreadSafeSimpleStreamableAssetManagerIndex = MakeShared<int32, ESPMode::ThreadSafe>(INDEX_NONE)
 
uint8 bUseCinematicMipLevels: 1
 
FStreamableRenderResourceState CachedSRRState
 

Friends

class FMediaTextureClockSink
 

Additional Inherited Members

- Static Public Member Functions inherited from UTexture
static ENGINE_API bool IsVirtualTexturingEnabled (const ITargetPlatformSettings *TargetPlatform=nullptr)
 
static ENGINE_API void CancelPendingTextureStreaming ()
 
static ENGINE_API const TCHARGetTextureGroupString (TextureGroup InGroup)
 
static ENGINE_API const TCHARGetMipGenSettingsString (TextureMipGenSettings InEnum)
 
static ENGINE_API TextureMipGenSettings GetMipGenSettingsFromString (const TCHAR *InStr, bool bTextureGroup)
 
static ENGINE_API bool ForceUpdateTextureStreaming ()
 
static ENGINE_API class UEnumGetPixelFormatEnum ()
 
static int32 GetStaticMinTextureResidentMipCount ()
 
static void SetMinTextureResidentMipCount (int32 InMinTextureResidentMipCount)
 
static ENGINE_API int32 GetMaximumDimensionOfNonVT ()
 
- Static Public Member Functions inherited from UObject
static COREUOBJECT_API void UpdateClassesExcludedFromDedicatedServer (const TArray< FString > &InClassNames, const TArray< FString > &InModulesNames)
 
static COREUOBJECT_API void UpdateClassesExcludedFromDedicatedClient (const TArray< FString > &InClassNames, const TArray< FString > &InModulesNames)
 
static COREUOBJECT_API bool CanCreateInCurrentContext (UObject *Template)
 
static COREUOBJECT_API void AddReferencedObjects (UObject *InThis, FReferenceCollector &Collector)
 
static COREUOBJECT_API const FNameSourceFileTagName ()
 
static COREUOBJECT_API UObjectGetArchetypeFromRequiredInfo (const UClass *Class, const UObject *Outer, FName Name, EObjectFlags ObjectFlags)
 
- Static Public Member Functions inherited from UObjectBaseUtility
static bool IsGarbageEliminationEnabled ()
 
static bool IsPendingKillEnabled ()
 
static void SetGarbageEliminationEnabled (bool bEnabled)
 
static COREUOBJECT_API void ReloadObjectsFromModifiedConfigSections (const class FConfigModificationTracker *ChangeTracker)
 
- Static Public Member Functions inherited from UObjectBase
static COREUOBJECT_API FString RemoveClassPrefix (const TCHAR *ClassName)
 
static void PrefetchClass (UObject *Object)
 
static void PrefetchOuter (UObject *Object)
 
- Static Public Attributes inherited from UTexture
static ENGINE_API FOnTextureSaved PreSaveEvent
 
- Static Protected Attributes inherited from UTexture
static ENGINE_API int32 GMinTextureResidentMipCount = NUM_INLINE_DERIVED_MIPS
 

Detailed Description

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?

Member Enumeration Documentation

◆ ERenderMode

Possible render modes of this media texture.

Enumerator
Default 
JustInTime 

Member Function Documentation

◆ BeginDestroy()

void UMediaTexture::BeginDestroy ( )
overridevirtual

Called before destroying the object. This is called immediately upon deciding to destroy the object, to allow the object to begin an asynchronous cleanup process.

Reimplemented from UTexture.

◆ CacheNextAvailableSampleTime()

void UMediaTexture::CacheNextAvailableSampleTime ( FTimespan  InNextSampleTime)

Caches the next available sample time from the queue when last rendering was made

See also
GetNextSampleTime

◆ CalcTextureMemorySizeEnum()

uint32 UMediaTexture::CalcTextureMemorySizeEnum ( ETextureMipCount  Enum) const
overridevirtual

Calculates the size of this texture if it had MipCount miplevels streamed in. This is the size in GPU memory of the built platformdata, accounting for LODBias, etc.

Parameters
EnumWhich mips to calculate size for.
Returns
Total size of all specified mips, in bytes. Returns 0 for error.

Reimplemented from UTexture.

◆ CreateResource()

FTextureResource * UMediaTexture::CreateResource ( )
overridevirtual

◆ GetAspectRatio()

float UMediaTexture::GetAspectRatio ( ) const

Gets the current aspect ratio of the texture.

Returns
Texture aspect ratio.
See also
GetHeight, GetWidth

◆ GetAvailableSampleCount()

int32 UMediaTexture::GetAvailableSampleCount ( ) const

Gets the number of samples that are available

Returns
The number of samples in the queue

◆ GetCurrentAspectRatio()

float UMediaTexture::GetCurrentAspectRatio ( ) const

Get current aspect ratio of presented frame.

Returns
Aspect ratio of current frame

◆ GetCurrentOrientation()

MediaTextureOrientation UMediaTexture::GetCurrentOrientation ( ) const

Get current orientation of presented frame.

Returns
Orientation of current frame

◆ GetDesc()

FString UMediaTexture::GetDesc ( void  )
overridevirtual

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

Reimplemented from UObject.

◆ GetExternalTextureGuid()

FGuid UMediaTexture::GetExternalTextureGuid ( ) const
overridevirtual

Access the GUID which defines this texture's resources externally through FExternalTextureRegistry

Reimplemented from UTexture.

◆ GetHeight()

int32 UMediaTexture::GetHeight ( ) const

Gets the current height of the texture.

Returns
Texture height (in pixels).
See also
GetAspectRatio, GetWidth

◆ GetMaterialType()

EMaterialValueType UMediaTexture::GetMaterialType ( ) const
overridevirtual

◆ GetMediaPlayer()

UMediaPlayer * UMediaTexture::GetMediaPlayer ( ) const

Get the media player that provides the video samples.

Returns
The texture's media player, or nullptr if not set.
See also
SetMediaPlayer

◆ GetMipMapBias()

float UMediaTexture::GetMipMapBias ( ) const

Get the texture's mip-map bias, clamped to a legal range.

Returns
Mip-map bias value

◆ GetNextSampleTime()

FTimespan UMediaTexture::GetNextSampleTime ( ) const

Gets the next sample Time. Only valid if GetAvailableSampleCount is greater than 0

Note
This value is cached when last render command was executed to keep single consumer requirements.
Returns
FTimespan of the next sample or FTimespan::MinValue if no sample was available in the queue.
See also
GetAvailableSampleCount, CacheNextAvailableSampleTime

◆ GetRenderMode()

ERenderMode UMediaTexture::GetRenderMode ( )
inline

Returns the ERenderMode of this media texture

◆ GetResourceSizeEx()

void UMediaTexture::GetResourceSizeEx ( FResourceSizeEx CumulativeResourceSize)
overridevirtual

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).

Parameters
CumulativeResourceSizeStruct used to count up the cumulative size of the resource as to be displayed to artists/LDs in the Editor.

Reimplemented from UObject.

◆ GetSurfaceArraySize()

virtual uint32 UMediaTexture::GetSurfaceArraySize ( ) const
inlineoverridevirtual

◆ GetSurfaceDepth()

virtual float UMediaTexture::GetSurfaceDepth ( ) const
inlineoverridevirtual

◆ GetSurfaceHeight()

float UMediaTexture::GetSurfaceHeight ( ) const
overridevirtual

◆ GetSurfaceWidth()

float UMediaTexture::GetSurfaceWidth ( ) const
overridevirtual

◆ GetTextureClass()

virtual ETextureClass UMediaTexture::GetTextureClass ( ) const
inlineoverridevirtual

◆ GetTextureNumMips()

int32 UMediaTexture::GetTextureNumMips ( ) const

Gets the current numbe of mips of the texture.

Returns
Number of mips.

◆ GetWidth()

int32 UMediaTexture::GetWidth ( ) const

Gets the current width of the texture.

Returns
Texture width (in pixels).
See also
GetAspectRatio, GetHeight

◆ IsPostLoadThreadSafe()

bool UMediaTexture::IsPostLoadThreadSafe ( ) const
overridevirtual

Called during async load to determine if PostLoad can be called on the loading thread.

Returns
true if this object's PostLoad is thread safe

Reimplemented from UTexture.

◆ JustInTimeRender()

void UMediaTexture::JustInTimeRender ( )
virtual

Renders this media texture. Only has an effect if its RenderMode is ERenderMode::JustInTime

◆ PostInitProperties()

void UMediaTexture::PostInitProperties ( )
overridevirtual

Called after the C++ constructor and after the properties have been initialized, including those loaded from config. This is called before any serialization or other setup has happened.

Reimplemented from UTexture.

◆ PostLoad()

void UMediaTexture::PostLoad ( )
overridevirtual

Do any object-specific cleanup required immediately after loading an object. This is not called for newly-created objects, and by default will always execute on the game thread.

Reimplemented from UTexture.

◆ SetColorSpaceOverride()

void UMediaTexture::SetColorSpaceOverride ( UE::Color::EColorSpace  InColorspaceOverride)
inline

Set an override for color space conversions

◆ SetMediaPlayer() [1/2]

void UMediaTexture::SetMediaPlayer ( UMediaPlayer NewMediaPlayer)

Set the media player that provides the video samples.

Parameters
NewMediaPlayerThe player to set.
See also
GetMediaPlayer

◆ SetMediaPlayer() [2/2]

void UMediaTexture::SetMediaPlayer ( UMediaPlayer NewMediaPlayer,
TSharedPtr< FMediaTextureSampleQueue InSampleQueue 
)

Set the media player that provides the video samples and optionally the sample queue that receives them. If no sample queue is provided, the media texture creates a new one internally.

Parameters
NewMediaPlayerThe player to set.
InSampleQueueProvide an optional sample queue to use instead of creating a new one.
See also
GetMediaPlayer

◆ SetMipMapBias()

void UMediaTexture::SetMipMapBias ( float  InMipMapBias)

Set texture's mip-map bias, for use by the texture resource sampler. Note: UpdateResource() should be called afterwards and the material should be notified.

Parameters
InMipMapBiasBias value.

◆ SetRenderedExternalTextureGuid()

void UMediaTexture::SetRenderedExternalTextureGuid ( const FGuid InNewGuid)

◆ SetRenderMode()

void UMediaTexture::SetRenderMode ( ERenderMode  InRenderMode)
inline

Sets the ERenderMode of this media texture

◆ TickResource()

void UMediaTexture::TickResource ( FTimespan  Timecode)
protected

Tick the texture resource.

Parameters
TimecodeThe current timecode.

◆ UpdatePlayerAndQueue()

void UMediaTexture::UpdatePlayerAndQueue ( TSharedPtr< FMediaTextureSampleQueue InSampleQueue = nullptr)
protected

Update the video sample queue, if necessary.

Parameters
InSampleQueueOptional sample queue to use.

◆ UpdateResource()

void UMediaTexture::UpdateResource ( )
inlinevirtual

Creates a new resource for the texture, and updates any cached references to the resource. This obviously is just an override to expose to blueprints. Since the base is deprecated in favor of the new params version, we remove the virtual override and pass the flags we care about here.

Reimplemented from UTexture.

◆ UpdateSampleInfo()

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

Update sample info

Friends And Related Symbol Documentation

◆ FMediaTextureClockSink

Member Data Documentation

◆ AddressX

TEnumAsByte<TextureAddress> UMediaTexture::AddressX

The addressing mode to use for the X axis.

◆ AddressY

TEnumAsByte<TextureAddress> UMediaTexture::AddressY

The addressing mode to use for the Y axis.

◆ AutoClear

bool UMediaTexture::AutoClear

Whether to clear the texture when no media is being played (default = enabled).

◆ ClearColor

FLinearColor UMediaTexture::ClearColor

The color used to clear the texture if AutoClear is enabled (default = black).

◆ CurrentAspectRatio

float UMediaTexture::CurrentAspectRatio

Current aspect ratio

◆ CurrentOrientation

TEnumAsByte<enum MediaTextureOrientation> UMediaTexture::CurrentOrientation

Current media orientation

◆ EnableGenMips

bool UMediaTexture::EnableGenMips

Basic enablement for mip generation (default = false).

◆ MediaPlayer

TObjectPtr<UMediaPlayer> UMediaTexture::MediaPlayer
protected

The media player asset associated with this texture.

This property is meant for design-time convenience. To change the associated media player at run-time, use the SetMediaPlayer method.

See also
SetMediaPlayer

◆ NewStyleOutput

bool UMediaTexture::NewStyleOutput

Allows the media texture to be used as a regular 2D texture in materials, with Color or Linear Color sampler types as opposed to External. Note however that external textures can remain more efficient on lower-end platforms (OpenGL ES).


The documentation for this class was generated from the following files: