VideoDecoderAllocationTypes.h File Reference

#include "CoreMinimal.h"

Go to the source code of this file.

Functions
enum	UE_DEPRECATED (5.4, "AVEncoder has been deprecated. Please use the AVCodecs plugin family instead.") EFrameBufferType
	DECLARE_DELEGATE_TwoParams (FRetainFrameBuffer, void *, void *)
	DECLARE_DELEGATE_TwoParams (FReleaseFrameBuffer, void *, void *)
PRAGMA_DISABLE_DEPRECATION_WARNINGS	DECLARE_DELEGATE_RetVal_ThreeParams (EFrameBufferAllocReturn, FAllocFrameBuffer, void *, const FVideoDecoderAllocFrameBufferParams *, FVideoDecoderAllocFrameBufferResult *)
PRAGMA_ENABLE_DEPRECATION_WARNINGS	DECLARE_DELEGATE_RetVal_ThreeParams (int32_t, FGetD3DDevice, void *, void **, int32_t *)
	DECLARE_DELEGATE_RetVal_FiveParams (int32_t, FMemAlloc, void *, void **, int32_t, int32_t, int32_t)
	DECLARE_DELEGATE_RetVal_ThreeParams (int32_t, FMemFree, void *, void **, int32_t)
	DECLARE_DELEGATE_RetVal_ThreeParams (int32_t, FConfigQuery, void *, void **, void **)

Function Documentation

DECLARE_DELEGATE_RetVal_FiveParams()

DECLARE_DELEGATE_RetVal_FiveParams	(	int32_t	,
		FMemAlloc	,
		void *	,
		void **	,
		int32_t	,
		int32_t	,
		int32_t
	)

DECLARE_DELEGATE_RetVal_ThreeParams() [1/4]

PRAGMA_DISABLE_DEPRECATION_WARNINGS DECLARE_DELEGATE_RetVal_ThreeParams	(	EFrameBufferAllocReturn	,
		FAllocFrameBuffer	,
		void *	,
		const FVideoDecoderAllocFrameBufferParams *	,
		FVideoDecoderAllocFrameBufferResult *
	)

Video frame buffer allocation callback within the application. We call this to get a new output frame buffer to decode into.

DECLARE_DELEGATE_RetVal_ThreeParams() [2/4]

DECLARE_DELEGATE_RetVal_ThreeParams	(	int32_t	,
		FConfigQuery	,
		void *	,
		void **	,
		void **
	)

DECLARE_DELEGATE_RetVal_ThreeParams() [3/4]

PRAGMA_ENABLE_DEPRECATION_WARNINGS DECLARE_DELEGATE_RetVal_ThreeParams	(	int32_t	,
		FGetD3DDevice	,
		void *	,
		void **	,
		int32_t *
	)

DECLARE_DELEGATE_RetVal_ThreeParams() [4/4]

DECLARE_DELEGATE_RetVal_ThreeParams	(	int32_t	,
		FMemFree	,
		void *	,
		void **	,
		int32_t
	)

DECLARE_DELEGATE_TwoParams() [1/2]

DECLARE_DELEGATE_TwoParams	(	FReleaseFrameBuffer	,
		void *	,
		void *
	)

Callback to release an allocated buffer

DECLARE_DELEGATE_TwoParams() [2/2]

DECLARE_DELEGATE_TwoParams	(	FRetainFrameBuffer	,
		void *	,
		void *
	)

Callback to retain an allocated buffer

UE_DEPRECATED()

struct UE_DEPRECATED ( 5.  4, "AVEncoder has been deprecated. Please use the AVCodecs plugin family instead."    )

strong

Type of video frame buffer to allocate.

Video frame buffer allocation parameters.

Return value for the video decoder frame buffer allocation callback.

Output buffer plane description.

Result structure to be filled in by the application.

Type of output frame buffer to allocate

Number of bytes to allocate with the specified alignment. For a raw buffer the allocation size is required as it may include oversize for padding. For a texture handle or a handle transfer buffer the allocation size is only what is required to carry the texture handle, which may be as little as 8 bytes for a single pointer only.

Dimensions to allocate raw buffer for.

Extra custom parameters (platform specific)

Buffer successfully allocated.

No resources available right now, try again later.

No resources available or some other failure.

Width of the allocated buffer plane in pixels, including necessary padding.

Height of the allocated buffer plane in pixels, including necessary padding.

Bytes per pixel.

Offset in bytes from the allocated buffer start address to the first pixel of this plane.

Offset in bytes between two pixels. Multiple of BytesPerPixel. Set larger for interleaved planes (eg. a UV plane).

Offset in bytes between the same column in the next row.

The buffer the application has allocated.

The actual buffer size the application has allocated.

Information of the allocated buffer planes, if applicable (depending on frame buffer type to allocate). Supports at most 4 planes (R,G,B,A). Usually 2 (Y, UV) or 3 (Y,U,V or R,G,B).

Callback within the application to retain the allocated buffer.

Callback within the application to release the allocated buffer.

Buffer callback user value (a 'this' pointer to something within the application) for the retain and release callbacks.

Magic cookie to check for if this is indeed the expected structure.

Client 'this' pointer passed in the callbacks.

Client method to allocate a frame buffer to receive a decoded image.

Client method to query the D3D device and D3D version used.

Magic cookie to check for if this is indeed the expected structure.

Client 'this' pointer passed in the callbacks.

Client method to allocate a frame buffer to receive a decoded image.

Client method to allocate specific memory.

Client method to free specific memory.

Client method to provide specific decoder configuration settings.