#include <CCTexture2D.h>

Inheritance diagram for Texture2D:

Classes
struct	PixelFormatInfo

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, NONE = -1 }
	Possible texture pixel formats. More...

typedef std::map < Texture2D::PixelFormat, const PixelFormatInfo >	PixelFormatInfoMap

Public Member Functions
	Texture2D ()
	ctor More...

virtual	~Texture2D ()
	NA NA More...

virtual std::string	getDescription () const
	NA NA 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 NA NA. 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)
	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 More...

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...

const char *	stringForFormat () const

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

unsigned int	bitsPerPixelForFormat () const

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

unsigned int	bitsPerPixelForFormat (Texture2D::PixelFormat format) const

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

bool	hasPremultipliedAlpha () const

bool	hasMipmaps () const

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

void	setGLProgram (GLProgram *program)

GLProgram *	getGLProgram () const

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 ()
	NA NA 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 Texture2D::PixelFormat	defaultAlphaPixelFormat ()

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

static const PixelFormatInfoMap &	getPixelFormatInfoMap ()

Protected Attributes
Texture2D::PixelFormat	_pixelFormat
	pixel format of the texture More...

int	_pixelsWide
	width in pixels More...

int	_pixelsHigh
	height in pixels More...

GLuint	_name
	texture name More...

GLfloat	_maxS
	texture max S More...

GLfloat	_maxT
	texture max T More...

Size	_contentSize
	content size More...

bool	_hasPremultipliedAlpha
	whether or not the texture has their Alpha premultiplied More...

bool	_hasMipmaps

GLProgram *	_shaderProgram
	shader program used by drawAtPoint and drawInRect More...

bool	_antialiasEnabled

Protected Attributes inherited from Ref
unsigned int	_referenceCount
	count of references More...

Static Protected Attributes
static const PixelFormatInfoMap	_pixelFormatInfoTables

Additional Inherited Members
Protected Member Functions inherited from Ref
	Ref ()
	Constructor. More...

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 Typedef Documentation

typedef std::map<Texture2D::PixelFormat, const PixelFormatInfo> PixelFormatInfoMap

Member Enumeration Documentation

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-compresed texture: ATC_INTERPOLATED_ALPHA.
DEFAULT	Default texture format: AUTO.
NONE

Constructor & Destructor Documentation

Texture2D ( )

ctor

virtual ~Texture2D ( )

virtual

NA NA

Member Function Documentation

unsigned int bitsPerPixelForFormat ( ) const

inline

unsigned int bitsPerPixelForFormat ( Texture2D::PixelFormat format ) const

inline

static Texture2D::PixelFormat defaultAlphaPixelFormat ( )

inlinestatic

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

void drawInRect ( const Rect & rect )

draws a texture inside a rect

void generateMipmap ( )

Generates mipmap images for the texture.

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

Since: v0.99.0

unsigned int getBitsPerPixelForFormat ( ) const

returns the bits-per-pixel of the in-memory OpenGL texture

Since: v1.0

unsigned int getBitsPerPixelForFormat ( Texture2D::PixelFormat format ) const

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

Since: v2.0

Size getContentSize ( ) const

const Size& getContentSizeInPixels ( )

content size

static Texture2D::PixelFormat getDefaultAlphaPixelFormat ( )

static

returns the alpha pixel format

Since: v0.8

virtual std::string getDescription ( ) const

virtual

NA NA

GLProgram* getGLProgram ( ) const

GLfloat getMaxS ( ) const

Gets max S.

GLfloat getMaxT ( ) const

Gets max T.

GLuint getName ( ) const

Gets the texture name.

Texture2D::PixelFormat getPixelFormat ( ) const

Gets the pixel format of the texture.

static const PixelFormatInfoMap& getPixelFormatInfoMap ( )

static

int getPixelsHigh ( ) const

Gets the height of the texture in pixels.

int getPixelsWide ( ) const

Gets the width of the texture in pixels.

const char* getStringForFormat ( ) const

returns the pixel format.

Since: v2.0

bool hasMipmaps ( ) const

bool hasPremultipliedAlpha ( ) const

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

Initializes with a texture2d with data NA NA.

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.

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.

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

Initializes with mipmaps.

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`
	)

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

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

Initializes a texture from a string using a text definition.

static void PVRImagesHavePremultipliedAlpha ( bool haveAlphaPremultiplied )

static

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

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

void releaseGLTexture ( )

release only the gl texture.

NA NA

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

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

static void setDefaultAlphaPixelFormat ( Texture2D::PixelFormat format )

static

sets the default pixel format for UIImagescontains alpha channel.

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

void setGLProgram ( GLProgram * program )

void setMaxS ( GLfloat maxS )

Sets max S.

void setMaxT ( GLfloat maxT )

Sets max T.

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)

void setTexParameters ( const TexParams * texParams )

inline

NA NA

const char* stringForFormat ( ) const

inline

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

Update with texture data.

Member Data Documentation

bool _antialiasEnabled

protected

Size _contentSize

protected

content size

bool _hasMipmaps

protected

bool _hasPremultipliedAlpha

protected

whether or not the texture has their Alpha premultiplied

GLfloat _maxS

protected

texture max S

GLfloat _maxT

protected

texture max T

GLuint _name

protected

texture name

Texture2D::PixelFormat _pixelFormat

protected

pixel format of the texture

const PixelFormatInfoMap _pixelFormatInfoTables

staticprotected

int _pixelsHigh

protected

height in pixels

int _pixelsWide

protected

width in pixels

GLProgram* _shaderProgram

protected

shader program used by drawAtPoint and drawInRect

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

/Users/huihoo/Software/huihoo-code/cocos2d-x/cocos2d-x-3.3/cocos/renderer/CCTexture2D.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation