You.i Engine
Public Member Functions | Protected Member Functions | List of all members
CYIImageDecoderGIF Class Reference
Assets

Detailed Description

Image decoder for the GIF file format. Animated images are not supported at this time.

#include <asset/YiImageDecoderGIF.h>

Inheritance diagram for CYIImageDecoderGIF:
Inheritance graph
[legend]

Public Member Functions

 CYIImageDecoderGIF ()
 
virtual ~CYIImageDecoderGIF ()
 
virtual bool GetImageDimensions (const CYIString &path, uint32_t *pnWidth, uint32_t *pnHeight) override
 
- Public Member Functions inherited from CYIImageDecoder
 CYIImageDecoder (bool bIsAnimationSupported, bool bIsPreallocatedBitmapSupported)
 
virtual ~CYIImageDecoder ()
 
bool IsAnimationSupported ()
 
bool IsPreAllocatedBitmapSupported ()
 
virtual bool IsFormatSupported (const uint8_t *pData, uint32_t nDataSize)
 
std::unique_ptr< CYIBitmap > Decode (const uint8_t *pData, uint32_t nDataSize, YI_DECODER_BITMAP_PARAMS *pParams=nullptr)
 
std::unique_ptr< CYIBitmap > Decode (const CYIString &path, YI_DECODER_BITMAP_PARAMS *pParams=nullptr)
 

Protected Member Functions

virtual std::unique_ptr< CYIBitmap > DecodeImpl (const CYIString &path, YI_DECODER_BITMAP_PARAMS *pParams) override
 
virtual std::unique_ptr< CYIBitmap > DecodeImpl (const uint8_t *fileData, uint32_t nDataSize, YI_DECODER_BITMAP_PARAMS *pParams) override
 
- Protected Member Functions inherited from CYIImageDecoder
void SetMagicByteInformation (uint32_t uMagicByteOffset, const std::vector< const char * > &possibleSequences)
 

Constructor & Destructor Documentation

CYIImageDecoderGIF::CYIImageDecoderGIF ( )
virtual CYIImageDecoderGIF::~CYIImageDecoderGIF ( )
virtual

Member Function Documentation

virtual std::unique_ptr<CYIBitmap> CYIImageDecoderGIF::DecodeImpl ( const CYIString &  path,
YI_DECODER_BITMAP_PARAMS *  pParams 
)
overrideprotectedvirtual

Decode an asset at the specified path.

Implements CYIImageDecoder.

virtual std::unique_ptr<CYIBitmap> CYIImageDecoderGIF::DecodeImpl ( const uint8_t *  pData,
uint32_t  nDataSize,
YI_DECODER_BITMAP_PARAMS *  pParams 
)
overrideprotectedvirtual

Decode an asset using pre-loaded file data pData and the nDataSize.

Implements CYIImageDecoder.

virtual bool CYIImageDecoderGIF::GetImageDimensions ( const CYIString &  path,
uint32_t *  pnWidth,
uint32_t *  pnHeight 
)
overridevirtual

Returns true if the image information can be loaded via the asset package path; the width and height of the asset will be returned through the pnWidth and pnHeight parameters.

Reimplemented from CYIImageDecoder.

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