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

#include <M4Image.h>

Public Member Functions

void Black ()
 Clear buffer.
 
void RefAdd ()
 Reference increase.
 
void RefRemove ()
 Reference decrease and free mem if drops to 0 references.
 
int32 RefGet () const
 Return current reference value.
 
M4DecodergetDecoder () const
 Return reference to our decoder.
 
voidoperator new (size_t sz, M4MemHandler &memSys)
 
void operator delete (void *ptr)
 

Static Public Member Functions

static M4Imagecreate (M4Decoder *decoder, int16 width, int16 height, bool poolMem=true)
 Construction and allocation of image helper.
 
static void destroy (M4Image *&pImage, M4Decoder *decoder)
 Destruction.
 
static void poolMemCb (void *memPtr, uint32 size, uint32 poolFlags, void *userData)
 Pool mem allocation callback.
 

Public Attributes

VIDImage mImage
 
VIDImageInfo mImageInfo
 Image information.
 

Friends

class M4Decoder
 Use special memory handling for this class.
 
struct VIDImage
 

Member Function Documentation

◆ Black()

void vdecmpeg4::M4Image::Black ( )

Clear buffer.

Set buffer to black

◆ create()

M4Image * vdecmpeg4::M4Image::create ( M4Decoder decoder,
int16  width,
int16  height,
bool  poolMem = true 
)
static

Construction and allocation of image helper.

Constructor for image buffer.

The provided image buffer is 'extended' with a padding area around all borders. Currently, this padding area is 32 pixel and this size is FIXED, because some assembler routines just ASSUME this size.

Parameters
decoder
widthoriginal image width
heightoriginal image height
Returns

◆ destroy()

void vdecmpeg4::M4Image::destroy ( M4Image *&  pImage,
M4Decoder decoder 
)
static

Destruction.

Static destruction

Parameters
pImage

◆ getDecoder()

M4Decoder & vdecmpeg4::M4Image::getDecoder ( ) const
inline

Return reference to our decoder.

◆ operator delete()

void vdecmpeg4::M4Image::operator delete ( void ptr)
inline

◆ operator new()

void * vdecmpeg4::M4Image::operator new ( size_t  sz,
M4MemHandler memSys 
)
inline

◆ poolMemCb()

void vdecmpeg4::M4Image::poolMemCb ( void memPtr,
uint32  size,
uint32  poolFlags,
void userData 
)
static

Pool mem allocation callback.

Static callback for pool memory allocation

Parameters
memPtr
poolFlags
userData

◆ RefAdd()

void vdecmpeg4::M4Image::RefAdd ( )
inline

Reference increase.

◆ RefGet()

int32 vdecmpeg4::M4Image::RefGet ( ) const
inline

Return current reference value.

◆ RefRemove()

void vdecmpeg4::M4Image::RefRemove ( )
inline

Reference decrease and free mem if drops to 0 references.

Friends And Related Symbol Documentation

◆ M4Decoder

friend class M4Decoder
friend

Use special memory handling for this class.

◆ VIDImage

Member Data Documentation

◆ mImage

VIDImage vdecmpeg4::M4Image::mImage

original image (without edges) A pointer to this will be returned to the caller

◆ mImageInfo

VIDImageInfo vdecmpeg4::M4Image::mImageInfo

Image information.


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