#include <CCImage.h>

Inheritance diagram for CCImage:

Collaboration diagram for CCImage:

Public Types
enum	EImageFormat { kFmtJpg = 0 , kFmtPng , kFmtTiff , kFmtWebp , kFmtRawData , kFmtUnKnown }

enum	ETextAlign { kAlignCenter = 0x33 , kAlignTop = 0x13 , kAlignTopRight = 0x12 , kAlignRight = 0x32 , kAlignBottomRight = 0x22 , kAlignBottom = 0x23 , kAlignBottomLeft = 0x21 , kAlignLeft = 0x31 , kAlignTopLeft = 0x11 }

Public Member Functions
	CCImage ()
	ctor More...

	~CCImage ()
	NA NA. More...

bool	initWithImageFile (const char *strPath, EImageFormat imageType=kFmtPng)
	Load the image from the specified path. More...

bool	initWithImageFileThreadSafe (const char *fullpath, EImageFormat imageType=kFmtPng)

bool	initWithImageData (void *pData, int nDataLen, EImageFormat eFmt=kFmtUnKnown, int nWidth=0, int nHeight=0, int nBitsPerComponent=8)
	Load image from stream buffer. More...

bool	initWithString (const char pText, int nWidth=0, int nHeight=0, ETextAlign eAlignMask=kAlignCenter, const char pFontName=0, int nSize=0)
	Create image with specified string. More...

bool	initWithStringShadowStroke (const char pText, int nWidth=0, int nHeight=0, ETextAlign eAlignMask=kAlignCenter, const char pFontName=0, int nSize=0, float textTintR=1, float textTintG=1, float textTintB=1, bool shadow=false, float shadowOffsetX=0.0, float shadowOffsetY=0.0, float shadowOpacity=0.0, float shadowBlur=0.0, bool stroke=false, float strokeR=1, float strokeG=1, float strokeB=1, float strokeSize=1)
	NA NA. More...

unsigned char *	getData ()

int	getDataLen ()

bool	hasAlpha ()

bool	isPremultipliedAlpha ()

bool	saveToFile (const char *pszFilePath, bool bIsToRGB=true)
	Save CCImage data to the specified file, with specified format. More...

virtual unsigned short	getWidth (void)

virtual unsigned short	getHeight (void)

virtual int	getBitsPerComponent (void)

Public Member Functions inherited from CCObject
	CCObject (void)

virtual	~CCObject (void)
	NA. More...

void	release (void)

void	retain (void)

CCObject *	autorelease (void)

CCObject *	copy (void)

bool	isSingleReference (void) const

unsigned int	retainCount (void) const

virtual bool	isEqual (const CCObject *pObject)

virtual void	acceptVisitor (CCDataVisitor &visitor)

virtual void	update (float dt)

	CCObject (const CCObject &)

CCObject &	operator= (const CCObject &)

virtual void	encodeWithCoder (DS_Dictionary *)

virtual bool	canEncode ()

CCObjectType	getObjType () const

virtual int	getTag () const

virtual void	setTag (int nTag)

void	setObjType (CCObjectType)

Public Member Functions inherited from CCCopying
virtual CCObject *	copyWithZone (CCZone *pZone)

Protected Member Functions
bool	_initWithJpgData (void *pData, int nDatalen)

bool	_initWithPngData (void *pData, int nDatalen)

bool	_initWithTiffData (void *pData, int nDataLen)

bool	_initWithWebpData (void *pData, int nDataLen)

bool	_initWithRawData (void *pData, int nDatalen, int nWidth, int nHeight, int nBitsPerComponent, bool bPreMulti)

bool	_saveImageToPNG (const char *pszFilePath, bool bIsToRGB=true)

bool	_saveImageToJPG (const char *pszFilePath)

Protected Attributes
unsigned short	m_nWidth

unsigned short	m_nHeight

int	m_nBitsPerComponent

unsigned char *	m_pData

bool	m_bHasAlpha

bool	m_bPreMulti

CCFreeTypeFont *	m_ft

Protected Attributes inherited from CCObject
unsigned int	m_uReference

unsigned int	m_uAutoReleaseCount

int	m_nTag

int	m_eObjType

unsigned int	m_uObjectIdxInArray

Additional Inherited Members
Static Public Member Functions inherited from CCObject
static CCObject *	createWithCoder (DS_Dictionary *)

Public Attributes inherited from CCObject
unsigned int	m_uID

int	m_nLuaID

Member Enumeration Documentation

◆ EImageFormat

enum EImageFormat

Enumerator
kFmtJpg
kFmtPng
kFmtTiff
kFmtWebp
kFmtRawData
kFmtUnKnown

◆ ETextAlign

enum ETextAlign

Enumerator
kAlignCenter	Horizontal center and vertical center.
kAlignTop	Horizontal center and vertical top.
kAlignTopRight	Horizontal right and vertical top.
kAlignRight	Horizontal right and vertical center.
kAlignBottomRight	Horizontal right and vertical bottom.
kAlignBottom	Horizontal center and vertical bottom.
kAlignBottomLeft	Horizontal left and vertical bottom.
kAlignLeft	Horizontal left and vertical center.
kAlignTopLeft	Horizontal left and vertical top.

Constructor & Destructor Documentation

◆ CCImage()

CCImage ( )

ctor

◆ ~CCImage()

~CCImage ( )

NA NA.

Member Function Documentation

◆ _initWithJpgData()

bool _initWithJpgData	(	void *	pData,
		int	nDatalen
	)

protected

◆ _initWithPngData()

bool _initWithPngData	(	void *	pData,
		int	nDatalen
	)

protected

◆ _initWithRawData()

bool _initWithRawData	(	void *	pData,
		int	nDatalen,
		int	nWidth,
		int	nHeight,
		int	nBitsPerComponent,
		bool	bPreMulti
	)

protected

◆ _initWithTiffData()

bool _initWithTiffData	(	void *	pData,
		int	nDataLen
	)

protected

◆ _initWithWebpData()

bool _initWithWebpData	(	void *	pData,
		int	nDataLen
	)

protected

◆ _saveImageToJPG()

bool _saveImageToJPG ( const char * pszFilePath )

protected

◆ _saveImageToPNG()

bool _saveImageToPNG	(	const char *	pszFilePath,
		bool	bIsToRGB = `true`
	)

protected

◆ getBitsPerComponent()

virtual int getBitsPerComponent ( void )

virtual

◆ getData()

unsigned char * getData ( )

inline

◆ getDataLen()

int getDataLen ( )

inline

◆ getHeight()

virtual unsigned short getHeight ( void )

virtual

◆ getWidth()

virtual unsigned short getWidth ( void )

virtual

◆ hasAlpha()

bool hasAlpha ( )

inline

◆ initWithImageData()

bool initWithImageData	(	void *	pData,
		int	nDataLen,
		EImageFormat	eFmt = `kFmtUnKnown`,
		int	nWidth = `0`,
		int	nHeight = `0`,
		int	nBitsPerComponent = `8`
	)

Load image from stream buffer.

Warning: kFmtRawData only supports RGBA8888.

Parameters

pBuffer	stream buffer which holds the image data.
nLength	data length expressed in (number of) bytes.
nWidth,nHeight,nBitsPerComponent	are used for kFmtRawData.

Returns: true if loaded correctly. NA

◆ initWithImageFile()

bool initWithImageFile	(	const char *	strPath,
		EImageFormat	imageType = `kFmtPng`
	)

Load the image from the specified path.

Parameters

strPath	the absolute file path.
imageType	the type of image, currently only supporting two types.

Returns: true if loaded correctly.

◆ initWithImageFileThreadSafe()

bool initWithImageFileThreadSafe	(	const char *	fullpath,
		EImageFormat	imageType = `kFmtPng`
	)

◆ initWithString()

bool initWithString	(	const char *	pText,
		int	nWidth = `0`,
		int	nHeight = `0`,
		ETextAlign	eAlignMask = `kAlignCenter`,
		const char *	pFontName = `0`,
		int	nSize = `0`
	)

Create image with specified string.

Parameters

pText	the text the image will show (cannot be nil).
nWidth	the image width, if 0, the width will match the text's width.
nHeight	the image height, if 0, the height will match the text's height.
eAlignMask	the test Alignment
pFontName	the name of the font used to draw the text. If nil, use the default system font.
nSize	the font size, if 0, use the system default size. NA

◆ initWithStringShadowStroke()

bool initWithStringShadowStroke	(	const char *	pText,
		int	nWidth = `0`,
		int	nHeight = `0`,
		ETextAlign	eAlignMask = `kAlignCenter`,
		const char *	pFontName = `0`,
		int	nSize = `0`,
		float	textTintR = `1`,
		float	textTintG = `1`,
		float	textTintB = `1`,
		bool	shadow = `false`,
		float	shadowOffsetX = `0.0`,
		float	shadowOffsetY = `0.0`,
		float	shadowOpacity = `0.0`,
		float	shadowBlur = `0.0`,
		bool	stroke = `false`,
		float	strokeR = `1`,
		float	strokeG = `1`,
		float	strokeB = `1`,
		float	strokeSize = `1`
	)

NA NA.

◆ isPremultipliedAlpha()

bool isPremultipliedAlpha ( )

inline

◆ saveToFile()

bool saveToFile	(	const char *	pszFilePath,
		bool	bIsToRGB = `true`
	)

Save CCImage data to the specified file, with specified format.

Parameters

pszFilePath	the file's absolute path, including file suffix.
bIsToRGB	whether the image is saved as RGB format.

Member Data Documentation

◆ m_bHasAlpha

bool m_bHasAlpha

protected

◆ m_bPreMulti

bool m_bPreMulti

protected

◆ m_ft

CCFreeTypeFont* m_ft

protected

◆ m_nBitsPerComponent

int m_nBitsPerComponent

protected

◆ m_nHeight

unsigned short m_nHeight

protected

◆ m_nWidth

unsigned short m_nWidth

protected

◆ m_pData

unsigned char* m_pData

protected

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

/home/runner/work/cocos-headers/cocos-headers/cocos2dx/platform/CCImage.h
/home/runner/work/cocos-headers/cocos-headers/cocos2dx/platform/CCImageCommon_cpp.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Enumeration Documentation

◆ EImageFormat

◆ ETextAlign

Constructor & Destructor Documentation

◆ CCImage()

◆ ~CCImage()

Member Function Documentation

◆ _initWithJpgData()

◆ _initWithPngData()

◆ _initWithRawData()

◆ _initWithTiffData()

◆ _initWithWebpData()

◆ _saveImageToJPG()

◆ _saveImageToPNG()

◆ getBitsPerComponent()

◆ getData()

◆ getDataLen()

◆ getHeight()

◆ getWidth()

◆ hasAlpha()

◆ initWithImageData()

◆ initWithImageFile()

◆ initWithImageFileThreadSafe()

◆ initWithString()

◆ initWithStringShadowStroke()

◆ isPremultipliedAlpha()

◆ saveToFile()

Member Data Documentation

◆ m_bHasAlpha

◆ m_bPreMulti

◆ m_ft

◆ m_nBitsPerComponent

◆ m_nHeight

◆ m_nWidth

◆ m_pData