1. Epic GamesDeveloper
  3. FMediaIOCoreTextureSampleBase

FMediaIOCoreTextureSampleBase

Implements the IMediaTextureSample/IMediaPoolable interface.

API > API/Plugins > API/Plugins/MediaIOCore

Implements the IMediaTextureSample/IMediaPoolable interface.

   
Name FMediaIOCoreTextureSampleBase
Type class
Header File /Engine/Plugins/Media/MediaIOFramework/Source/MediaIOCore/Public/MediaIOCoreTextureSampleBase.h
Include Path #include "MediaIOCoreTextureSampleBase.h"

Syntax

class FMediaIOCoreTextureSampleBase :  
    public IMediaTextureSample ,  
    public IMediaPoolable ,  
    public IMediaTextureSampleColorConverter ,  
    public TSharedFromThis< FMediaIOCoreTextureSampleBase, ESPMode::ThreadSafe >

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

FMediaIOCoreTextureSampleBase()

   MediaIOCoreTextureSampleBase.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bIsAwaitingForGPUTransfer std::atomic< bool > Whether this sample's texture data is awaiting to be transferred by GPUDirect MediaIOCoreTextureSampleBase.h  
CachedOCIOResources TSharedPtr< struct FOpenColorIORenderPassResources > Cached rendering resources used for the color conversion pass when using OCIO. MediaIOCoreTextureSampleBase.h  
ColorConversionSettings TSharedPtr< struct FOpenColorIOColorConversionSettings > Settings used to apply an OCIO conversion to the sample. MediaIOCoreTextureSampleBase.h  
DestructionCallback TFunction< void(TRefCountPtr< FRHITexture >)> Called when the sample is destroyed by its pool. MediaIOCoreTextureSampleBase.h  
EvaluationOffsetInSeconds double Time offset evaluated on game thread for JITR MediaIOCoreTextureSampleBase.h  
OriginalSample TSharedPtr< FMediaIOCoreTextureSampleBase > A reference to the original sample that was chosen during JITR. MediaIOCoreTextureSampleBase.h  
Texture TRefCountPtr< FRHITexture > Hold a texture to be used for gpu texture transfers. MediaIOCoreTextureSampleBase.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void CopyConfiguration ( const TSharedPtr< FMediaIOCoreTextureSampleBase >& SourceSample
)

 Copies all neccessary data from a source sample to render JIT MediaIOCoreTextureSampleBase.h  

virtual UE::Color::EColorSpace GetColorSpaceType()

 Method that returns this sample's colorspace type. MediaIOCoreTextureSampleBase.h  

double GetEvaluationOffsetInSeconds()

 Returns time evaluated on the game thread for JITR MediaIOCoreTextureSampleBase.h  

virtual uint64 GetFrameNumber()

   MediaIOCoreTextureSampleBase.h  

void * GetMutableBuffer()

   MediaIOCoreTextureSampleBase.h  

virtual void * GetOrRequestBuffer ( uint32 InBufferSize
)

 Attemps to get the initialized buffer. MediaIOCoreTextureSampleBase.h  

EPixelFormat GetPixelFormat()

   MediaIOCoreTextureSampleBase.h  
Returns the player that created this sample MediaIOCoreTextureSampleBase.h  

bool Initialize ( const void* InVideoBuffer,
uint32 InBufferSize,
uint32 InStride,
uint32 InWidth,
uint32 InHeight,
EMediaTextureSampleFormat InSampleFormat,
FTimespan InTime,
const FFrameRate& InFrameRate,
const TOptional< FTimecode >& InTimecode,
const UE::MediaIOCore::FColorFormatArgs& InColorFormatArgs
)

 Initialize the sample. MediaIOCoreTextureSampleBase.h  

bool Initialize ( TArray< uint8 >&& InVideoBuffer,
uint32 InStride,
uint32 InWidth,
uint32 InHeight,
EMediaTextureSampleFormat InSampleFormat,
FTimespan InTime,
const FFrameRate& InFrameRate,
const TOptional< FTimecode >& InTimecode,
const UE::MediaIOCore::FColorFormatArgs& InColorFormatArgs
)

 Initialize the sample. MediaIOCoreTextureSampleBase.h  

bool Initialize ( const TArray< uint8 >& InVideoBuffer,
uint32 InStride,
uint32 InWidth,
uint32 InHeight,
EMediaTextureSampleFormat InSampleFormat,
FTimespan InTime,
const FFrameRate& InFrameRate,
const TOptional< FTimecode >& InTimecode,
const UE::MediaIOCore::FColorFormatArgs& InColorFormatArgs
)

 Initialize the sample. MediaIOCoreTextureSampleBase.h  

virtual bool InitializeJITR ( const FMediaIOCoreSampleJITRConfigurationArgs& Args
)

 Configure this sample for JITR MediaIOCoreTextureSampleBase.h  

bool InitializeWithEvenOddLine ( bool bUseEvenLine,
const void* InVideoBuffer,
uint32 InBufferSize,
uint32 InStride,
uint32 InWidth,
uint32 InHeight,
EMediaTextureSampleFormat InSampleFormat,
FTimespan InTime,
const FFrameRate& InFrameRate,
const TOptional< FTimecode >& InTimecode,
const UE::MediaIOCore::FColorFormatArgs& InColorFormatArgs
)

 Initialize the sample with half it's original height and take only the odd or even line. MediaIOCoreTextureSampleBase.h  

bool IsAwaitingForGPUTransfer()

 Returns whether it's ready for GPUDirect texture transfer MediaIOCoreTextureSampleBase.h  

virtual void * RequestBuffer ( uint32 InBufferSize
)

 Request an uninitialized sample buffer. MediaIOCoreTextureSampleBase.h  

void SetAwaitingForGPUTransfer ( bool bIsAwaitingGPUTransfer
)

 Marks this sample as one that is ready and awaiting for fast GPUDirect texture transfer MediaIOCoreTextureSampleBase.h  

bool SetBuffer ( TArray< uint8 >&& InVideoBuffer
)

 Set the sample buffer. MediaIOCoreTextureSampleBase.h  

bool SetBuffer ( const TArray< uint8 >& InVideoBuffer
)

 Set the sample buffer. MediaIOCoreTextureSampleBase.h  

bool SetBuffer ( const void* InVideoBuffer,
uint32 InBufferSize
)

 Initialize the sample. MediaIOCoreTextureSampleBase.h  

void SetBuffer ( void* InBuffer
)

   MediaIOCoreTextureSampleBase.h  

bool SetBufferWithEvenOddLine ( bool bUseEvenLine,
const void* InVideoBuffer,
uint32 InBufferSize,
uint32 InStride,
uint32 InHeight
)

 Set the sample buffer with half it's original height and take only the odd or even line. MediaIOCoreTextureSampleBase.h  

void SetColorConversionSettings ( TSharedPtr< struct FOpenColorIOColorConversionSettings > InColorConversionSettings
)

 Set the OCIO settings used for color conversion. MediaIOCoreTextureSampleBase.h  

void SetDestructionCallback ( TFunction< void(TRefCountPtr< FRHITexture >)> InDestructionCallback
)

   MediaIOCoreTextureSampleBase.h  

virtual void SetFrameNumber ( uint32 InFrameNumber
)

   MediaIOCoreTextureSampleBase.h  

bool SetProperties ( uint32 InStride,
uint32 InWidth,
uint32 InHeight,
EMediaTextureSampleFormat InSampleFormat,
FTimespan InTime,
const FFrameRate& InFrameRate,
const TOptional< FTimecode >& InTimecode,
const UE::MediaIOCore::FColorFormatArgs& InColorFormatArgs
)

 Set the sample properties. MediaIOCoreTextureSampleBase.h  

void SetTexture ( TRefCountPtr< FRHITexture > InRHITexture
)

   MediaIOCoreTextureSampleBase.h  

virtual void SetTime ( const FTimespan& InTime
)

   MediaIOCoreTextureSampleBase.h  

Overridden from IMediaTextureSample

Name Remarks Include Path Unreal Specifiers

virtual const void * GetBuffer()

   MediaIOCoreTextureSampleBase.h  

virtual FIntPoint GetDim()

   MediaIOCoreTextureSampleBase.h  

virtual FTimespan GetDuration()

   MediaIOCoreTextureSampleBase.h  

virtual UE::Color::EEncoding GetEncodingType()

   MediaIOCoreTextureSampleBase.h  

virtual EMediaTextureSampleFormat GetFormat()

   MediaIOCoreTextureSampleBase.h  

virtual float GetHDRNitsNormalizationFactor()

   MediaIOCoreTextureSampleBase.h  

virtual FIntPoint GetOutputDim()

   MediaIOCoreTextureSampleBase.h  

virtual const UE::Color::FColorSpace & GetSourceColorSpace()

   MediaIOCoreTextureSampleBase.h  

virtual uint32 GetStride()

   MediaIOCoreTextureSampleBase.h  

virtual FMediaTimeStamp GetTime()

   MediaIOCoreTextureSampleBase.h  

virtual TOptional< FTimecode > GetTimecode()

   MediaIOCoreTextureSampleBase.h  

virtual bool IsCacheable()

   MediaIOCoreTextureSampleBase.h  

virtual bool IsOutputSrgb()

   MediaIOCoreTextureSampleBase.h  

Overridden from IMediaPoolable

Name Remarks Include Path Unreal Specifiers

virtual void ShutdownPoolable()

   MediaIOCoreTextureSampleBase.h  

Overridden from IMediaTextureSampleColorConverter

Name Remarks Include Path Unreal Specifiers

virtual bool ApplyColorConversion ( FRHICommandListImmediate& RHICmdList,
FTextureRHIRef& InSrcTexture,
FTextureRHIRef& InDstTexture
)

   MediaIOCoreTextureSampleBase.h  

Protected

Name Remarks Include Path Unreal Specifiers

void CacheColorCoversionSettings_GameThread()

 Method that caches color conversion settings on Game thread. MediaIOCoreTextureSampleBase.h  

virtual void FreeSample()

   MediaIOCoreTextureSampleBase.h  

Overridden from IMediaTextureSample

Name Remarks Include Path Unreal Specifiers

virtual const FMatrix & GetYUVToRGBMatrix()

 Get YUV to RGB conversion matrix MediaIOCoreTextureSampleBase.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page