Inheritance diagram for Texture2D:

Public Types
enum	PixelFormat { AUTO, BGRA8888, RGBA8888, RGB888, RGB565, A8, I8, AI88, RGBA4444, RGB5A1, PVRTC4, PVRTC4A, PVRTC2, PVRTC2A, ETC, S3TC_DXT1, S3TC_DXT3, S3TC_DXT5, ATC_RGB, ATC_EXPLICIT_ALPHA, ATC_INTERPOLATED_ALPHA, DEFAULT = AUTO }
	Possible texture pixel formats. More...

Public Member Functions
	Texture2D ()
	ctor

virtual	~Texture2D ()
	NA NA

virtual std::string	getDescription () const
	Get texture name, dimensions and coordinates message by a string. More...

void	releaseGLTexture ()
	Release only the gl texture. More...

bool	initWithData (const void *data, ssize_t dataLen, Texture2D::PixelFormat pixelFormat, int pixelsWide, int pixelsHigh, const Size &contentSize)
	Initializes with a texture2d with data. More...

bool	initWithMipmaps (MipmapInfo *mipmaps, int mipmapsNum, Texture2D::PixelFormat pixelFormat, int pixelsWide, int pixelsHigh)
	Initializes with mipmaps. More...

bool	updateWithData (const void *data, int offsetX, int offsetY, int width, int height)
	Update with texture data. More...

void	drawAtPoint (const Vec2 &point)
	Drawing extensions to make it easy to draw basic quads using a Texture2D object. More...

void	drawInRect (const Rect &rect)
	Draws a texture inside a rect. More...

bool	initWithImage (Image *image)
	Extensions to make it easy to create a Texture2D object from an image file. More...

bool	initWithImage (Image *image, PixelFormat format)
	Initializes a texture from a UIImage object. More...

bool	initWithString (const char *text, const std::string &fontName, float fontSize, const Size &dimensions=Size(0, 0), TextHAlignment hAlignment=TextHAlignment::CENTER, TextVAlignment vAlignment=TextVAlignment::TOP, bool enableWrap=true, int overflow=0)
	Initializes a texture from a string with dimensions, alignment, font name and font size. More...

bool	initWithString (const char *text, const FontDefinition &textDefinition)
	Initializes a texture from a string using a text definition. More...

void	setTexParameters (const TexParams &texParams)
	Sets the min filter, mag filter, wrap s and wrap t texture parameters. More...

void	setTexParameters (const TexParams *texParams)
	NA NA

void	setAntiAliasTexParameters ()
	Sets antialias texture parameters: More...

void	setAliasTexParameters ()
	Sets alias texture parameters: More...

void	generateMipmap ()
	Generates mipmap images for the texture. More...

const char *	getStringForFormat () const
	Returns the pixel format. More...

unsigned int	getBitsPerPixelForFormat () const
	Returns the bits-per-pixel of the in-memory OpenGL texture. More...

unsigned int	getBitsPerPixelForFormat (Texture2D::PixelFormat format) const
	Helper functions that returns bits per pixels for a given format. More...

const Size &	getContentSizeInPixels ()
	Get content size. More...

bool	hasPremultipliedAlpha () const
	Whether or not the texture has their Alpha premultiplied. More...

bool	hasMipmaps () const
	Whether or not the texture has mip maps. More...

Texture2D::PixelFormat	getPixelFormat () const
	Gets the pixel format of the texture. More...

int	getPixelsWide () const
	Gets the width of the texture in pixels. More...

int	getPixelsHigh () const
	Gets the height of the texture in pixels. More...

GLuint	getName () const
	Gets the texture name. More...

GLfloat	getMaxS () const
	Gets max S. More...

void	setMaxS (GLfloat maxS)
	Sets max S. More...

GLfloat	getMaxT () const
	Gets max T. More...

void	setMaxT (GLfloat maxT)
	Sets max T. More...

Size	getContentSize () const
	Get the texture content size. More...

void	setGLProgram (GLProgram *program)
	Set a shader program to the texture. More...

GLProgram *	getGLProgram () const
	Get a shader program from the texture. More...

Public Member Functions inherited from Ref
void	retain ()
	Retains the ownership. More...

void	release ()
	Releases the ownership immediately. More...

Ref *	autorelease ()
	Releases the ownership sometime soon automatically. More...

unsigned int	getReferenceCount () const
	Returns the Ref's current reference count. More...

virtual	~Ref ()
	Destructor. More...

Static Public Member Functions
static void	setDefaultAlphaPixelFormat (Texture2D::PixelFormat format)
	sets the default pixel format for UIImagescontains alpha channel. More...

static Texture2D::PixelFormat	getDefaultAlphaPixelFormat ()
	Returns the alpha pixel format. More...

static void	PVRImagesHavePremultipliedAlpha (bool haveAlphaPremultiplied)
	Treats (or not) PVR files as if they have alpha premultiplied. More...

static const PixelFormatInfoMap &	getPixelFormatInfoMap ()
	Get pixel info map, the key-value pairs is PixelFormat and PixelFormatInfo. More...

Additional Inherited Members
Public Attributes inherited from Ref
unsigned int	_ID
	object id, ScriptSupport need public _ID

int	_luaID
	Lua reference id.

void *	_scriptObject
	scriptObject, support for swift

bool	_rooted
	When true, it means that the object was already rooted.

Detailed Description

Texture2D class.

This class allows to easily create OpenGL 2D textures from images, text or raw data. The created Texture2D object will always have power-of-two dimensions. Depending on how you create the Texture2D object, the actual image area of the texture might be smaller than the texture dimensions i.e. "contentSize" != (pixelsWide, pixelsHigh) and (maxS, maxT) != (1.0, 1.0). Be aware that the content of the generated textures will be upside-down!

Member Enumeration Documentation

◆ PixelFormat

enum PixelFormat

strong

Possible texture pixel formats.

Enumerator
AUTO	auto detect the type
BGRA8888	32-bit texture: BGRA8888
RGBA8888	32-bit texture: RGBA8888
RGB888	24-bit texture: RGBA888
RGB565	16-bit texture without Alpha channel
A8	8-bit textures used as masks
I8	8-bit intensity texture
AI88	16-bit textures used as masks
RGBA4444	16-bit textures: RGBA4444
RGB5A1	16-bit textures: RGB5A1
PVRTC4	4-bit PVRTC-compressed texture: PVRTC4
PVRTC4A	4-bit PVRTC-compressed texture: PVRTC4 (has alpha channel)
PVRTC2	2-bit PVRTC-compressed texture: PVRTC2
PVRTC2A	2-bit PVRTC-compressed texture: PVRTC2 (has alpha channel)
ETC	ETC-compressed texture: ETC.
S3TC_DXT1	S3TC-compressed texture: S3TC_Dxt1.
S3TC_DXT3	S3TC-compressed texture: S3TC_Dxt3.
S3TC_DXT5	S3TC-compressed texture: S3TC_Dxt5.
ATC_RGB	ATITC-compressed texture: ATC_RGB.
ATC_EXPLICIT_ALPHA	ATITC-compressed texture: ATC_EXPLICIT_ALPHA.
ATC_INTERPOLATED_ALPHA	ATITC-compressed texture: ATC_INTERPOLATED_ALPHA.
DEFAULT	Default texture format: AUTO.

Member Function Documentation

◆ setDefaultAlphaPixelFormat()

static void setDefaultAlphaPixelFormat ( Texture2D::PixelFormat format )

static

sets the default pixel format for UIImagescontains alpha channel.

Parameters

format

If the UIImage contains alpha channel, then the options are:

generate 32-bit textures: Texture2D::PixelFormat::RGBA8888 (default one)
generate 24-bit textures: Texture2D::PixelFormat::RGB888
generate 16-bit textures: Texture2D::PixelFormat::RGBA4444
generate 16-bit textures: Texture2D::PixelFormat::RGB5A1
generate 16-bit textures: Texture2D::PixelFormat::RGB565
generate 8-bit textures: Texture2D::PixelFormat::A8 (only use it if you use just 1 color)

How does it work ?

If the image is an RGBA (with Alpha) then the default pixel format will be used (it can be a 8-bit, 16-bit or 32-bit texture)
If the image is an RGB (without Alpha) then: If the default pixel format is RGBA8888 then a RGBA8888 (32-bit) will be used. Otherwise a RGB565 (16-bit texture) will be used.

This parameter is not valid for PVR / PVR.CCZ images.

Since: v0.8

◆ getDefaultAlphaPixelFormat()

static Texture2D::PixelFormat getDefaultAlphaPixelFormat ( )

static

Returns the alpha pixel format.

Since: v0.8

◆ PVRImagesHavePremultipliedAlpha()

static void PVRImagesHavePremultipliedAlpha ( bool haveAlphaPremultiplied )

static

Treats (or not) PVR files as if they have alpha premultiplied.

Parameters

haveAlphaPremultiplied Since it is impossible to know at runtime if the PVR images have the alpha channel premultiplied, it is possible load them as if they have (or not) the alpha channel premultiplied.

By default it is disabled.

deprecated, please use Image::setPVRImagesHavePremultipliedAlpha() instead.

Since: v0.99.5

◆ getDescription()

virtual std::string getDescription ( ) const

virtual

Get texture name, dimensions and coordinates message by a string.

NA NA

◆ releaseGLTexture()

void releaseGLTexture ( )

Release only the gl texture.

NA NA

◆ initWithData()

bool initWithData	(	const void *	data,
		ssize_t	dataLen,
		Texture2D::PixelFormat	pixelFormat,
		int	pixelsWide,
		int	pixelsHigh,
		const Size &	contentSize
	)

Initializes with a texture2d with data.

Parameters

data	Specifies a pointer to the image data in memory.
dataLen	The image data length.
pixelFormat	The image pixelFormat.
pixelsWide	The image width.
pixelsHigh	The image height.
contentSize	The image content size. NA NA

◆ initWithMipmaps()

bool initWithMipmaps	(	MipmapInfo *	mipmaps,
		int	mipmapsNum,
		Texture2D::PixelFormat	pixelFormat,
		int	pixelsWide,
		int	pixelsHigh
	)

Initializes with mipmaps.

Parameters

mipmaps	Specifies a pointer to the image data in memory.
mipmapsNum	The mipmaps number.
pixelFormat	The image pixelFormat.
pixelsWide	The image width.
pixelsHigh	The image height.

◆ updateWithData()

bool updateWithData	(	const void *	data,
		int	offsetX,
		int	offsetY,
		int	width,
		int	height
	)

Update with texture data.

Parameters

data	Specifies a pointer to the image data in memory.
offsetX	Specifies a texel offset in the x direction within the texture array.
offsetY	Specifies a texel offset in the y direction within the texture array.
width	Specifies the width of the texture subimage.
height	Specifies the height of the texture subimage.

◆ drawAtPoint()

void drawAtPoint ( const Vec2 & point )

Drawing extensions to make it easy to draw basic quads using a Texture2D object.

These functions require GL_TEXTURE_2D and both GL_VERTEX_ARRAY and GL_TEXTURE_COORD_ARRAY client states to be enabled.Draws a texture at a given point.

◆ drawInRect()

void drawInRect ( const Rect & rect )

Draws a texture inside a rect.

◆ initWithImage() [1/2]

bool initWithImage ( Image * image )

Extensions to make it easy to create a Texture2D object from an image file.

Initializes a texture from a UIImage object.

We will use the format you specified with setDefaultAlphaPixelFormat to convert the image for texture. NOTE: It will not convert the pvr image file.

Parameters

image An UIImage object.

◆ initWithImage() [2/2]

bool initWithImage	(	Image *	image,
		PixelFormat	format
	)

Initializes a texture from a UIImage object.

We will use the format you passed to the function to convert the image format to the texture format. If you pass PixelFormat::Automatic, we will auto detect the image render type and use that type for texture to render.

Parameters

image	An UIImage object.
format	Texture pixel formats.

◆ initWithString() [1/2]

bool initWithString	(	const char *	text,
		const std::string &	fontName,
		float	fontSize,
		const Size &	dimensions = `Size(0, 0)`,
		TextHAlignment	hAlignment = `TextHAlignment::CENTER`,
		TextVAlignment	vAlignment = `TextVAlignment::TOP`,
		bool	enableWrap = `true`,
		int	overflow = `0`
	)

Initializes a texture from a string with dimensions, alignment, font name and font size.

Parameters

text	A null terminated string.
fontName	The font name.
fontSize	The font size.
dimensions	The font dimension.
hAlignment	The font horizontal text alignment type.
vAlignment	The font vertical text alignment type.
enableWrap	Whether enable text wrap or not.
overflow	Whether shrink font size when content larger than the dimensions.

◆ initWithString() [2/2]

bool initWithString	(	const char *	text,
		const FontDefinition &	textDefinition
	)

Initializes a texture from a string using a text definition.

Parameters

text	A null terminated string.
textDefinition	A FontDefinition object contains font attributes.

◆ setTexParameters()

void setTexParameters ( const TexParams & texParams )

Sets the min filter, mag filter, wrap s and wrap t texture parameters.

If the texture size is NPOT (non power of 2), then in can only use GL_CLAMP_TO_EDGE in GL_TEXTURE_WRAP_{S,T}.

Warning: Calling this method could allocate additional texture memory.

Since: v0.8
When this function bound into js or lua,the input parameter will be changed
In js: var setBlendFunc(var arg1, var arg2, var arg3, var arg4)
In lua: local setBlendFunc(local arg1, local arg2, local arg3, local arg4)

◆ setAntiAliasTexParameters()

void setAntiAliasTexParameters ( )

Sets antialias texture parameters:

GL_TEXTURE_MIN_FILTER = GL_LINEAR
GL_TEXTURE_MAG_FILTER = GL_LINEAR

Warning: Calling this method could allocate additional texture memory.

Since: v0.8

◆ setAliasTexParameters()

void setAliasTexParameters ( )

Sets alias texture parameters:

GL_TEXTURE_MIN_FILTER = GL_NEAREST
GL_TEXTURE_MAG_FILTER = GL_NEAREST

Warning: Calling this method could allocate additional texture memory.

Since: v0.8

◆ generateMipmap()

void generateMipmap ( )

Generates mipmap images for the texture.

It only works if the texture size is POT (power of 2).

Since: v0.99.0

◆ getStringForFormat()

const char* getStringForFormat ( ) const

Returns the pixel format.

Since: v2.0

◆ getBitsPerPixelForFormat() [1/2]

unsigned int getBitsPerPixelForFormat ( ) const

Returns the bits-per-pixel of the in-memory OpenGL texture.

Since: v1.0

◆ getBitsPerPixelForFormat() [2/2]

unsigned int getBitsPerPixelForFormat ( Texture2D::PixelFormat format ) const

Helper functions that returns bits per pixels for a given format.

Since: v2.0

◆ getContentSizeInPixels()

const Size& getContentSizeInPixels ( )

Get content size.

◆ hasPremultipliedAlpha()

bool hasPremultipliedAlpha ( ) const

Whether or not the texture has their Alpha premultiplied.

◆ hasMipmaps()

bool hasMipmaps ( ) const

Whether or not the texture has mip maps.

◆ getPixelFormat()

Texture2D::PixelFormat getPixelFormat ( ) const

Gets the pixel format of the texture.

◆ getPixelsWide()

int getPixelsWide ( ) const

Gets the width of the texture in pixels.

◆ getPixelsHigh()

int getPixelsHigh ( ) const

Gets the height of the texture in pixels.

◆ getName()

GLuint getName ( ) const

Gets the texture name.

◆ getMaxS()

GLfloat getMaxS ( ) const

Gets max S.

◆ setMaxS()

void setMaxS ( GLfloat maxS )

Sets max S.

◆ getMaxT()

GLfloat getMaxT ( ) const

Gets max T.

◆ setMaxT()

void setMaxT ( GLfloat maxT )

Sets max T.

◆ getContentSize()

Size getContentSize ( ) const

Get the texture content size.

◆ setGLProgram()

void setGLProgram ( GLProgram * program )

Set a shader program to the texture.

It's used by drawAtPoint and drawInRect

◆ getGLProgram()

GLProgram* getGLProgram ( ) const

Get a shader program from the texture.

◆ getPixelFormatInfoMap()

static const PixelFormatInfoMap& getPixelFormatInfoMap ( )

static

Get pixel info map, the key-value pairs is PixelFormat and PixelFormatInfo.

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

CCTexture2D.h

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ PixelFormat

Member Function Documentation

◆ setDefaultAlphaPixelFormat()

◆ getDefaultAlphaPixelFormat()

◆ PVRImagesHavePremultipliedAlpha()

◆ getDescription()

◆ releaseGLTexture()

◆ initWithData()

◆ initWithMipmaps()

◆ updateWithData()

◆ drawAtPoint()

◆ drawInRect()

◆ initWithImage() [1/2]

◆ initWithImage() [2/2]

◆ initWithString() [1/2]

◆ initWithString() [2/2]

◆ setTexParameters()

◆ setAntiAliasTexParameters()

◆ setAliasTexParameters()

◆ generateMipmap()

◆ getStringForFormat()

◆ getBitsPerPixelForFormat() [1/2]

◆ getBitsPerPixelForFormat() [2/2]

◆ getContentSizeInPixels()

◆ hasPremultipliedAlpha()

◆ hasMipmaps()

◆ getPixelFormat()

◆ getPixelsWide()

◆ getPixelsHigh()

◆ getName()

◆ getMaxS()

◆ setMaxS()

◆ getMaxT()

◆ setMaxT()

◆ getContentSize()

◆ setGLProgram()

◆ getGLProgram()

◆ getPixelFormatInfoMap()