Texture2D Class Reference

Texture2D class. More...

#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 ()
	Texture2D ()
virtual	~Texture2D ()
virtual std::string	getDescription () const
	Get texutre 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...
var	drawAtPoint ( var point)
	Drawing extensions to make it easy to draw basic quads using a Texture2D object. More...
local	drawAtPoint ( local 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...
local	initWithString ( local text, local fontName, local fontSize, local 0, local CENTER, local 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)
void	setAntiAliasTexParameters ()
	Sets antialias texture parameters: More...
var	setAntiAliasTexParameters ()
	Sets antialias texture parameters: More...
local	setAntiAliasTexParameters ()
	Sets antialias texture parameters: More...
void	setAliasTexParameters ()
	Sets alias texture parameters: More...
var	setAliasTexParameters ()
	Sets alias texture parameters: More...
local	setAliasTexParameters ()
	Sets alias texture parameters: More...
void	generateMipmap ()
	Generates mipmap images for the texture. More...
const char *	getStringForFormat () const
	Returns the pixel format. More...
local	getStringForFormat ()
	Returns the pixel format. More...
const char *	stringForFormat () const
var	stringForFormat ()
local	stringForFormat ()
unsigned int	getBitsPerPixelForFormat () const
	Returns the bits-per-pixel of the in-memory OpenGL texture. More...
unsigned int	bitsPerPixelForFormat () const
var	bitsPerPixelForFormat ()
local	bitsPerPixelForFormat ()
unsigned int	getBitsPerPixelForFormat (Texture2D::PixelFormat format) const
	Helper functions that returns bits per pixels for a given format. More...
var	getBitsPerPixelForFormat ( var format)
	Helper functions that returns bits per pixels for a given format. More...
local	getBitsPerPixelForFormat ( local format)
	Helper functions that returns bits per pixels for a given format. More...
unsigned int	bitsPerPixelForFormat (Texture2D::PixelFormat format) const
var	bitsPerPixelForFormat ( var format)
local	bitsPerPixelForFormat ( local format)
const Size &	getContentSizeInPixels ()
	Get content size. More...
var	getContentSizeInPixels ()
	Get content size. More...
local	getContentSizeInPixels ()
	Get content size. More...
bool	hasPremultipliedAlpha () const
	Whether or not the texture has their Alpha premultiplied. More...
var	hasPremultipliedAlpha ()
	Whether or not the texture has their Alpha premultiplied. More...
local	hasPremultipliedAlpha ()
	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...
var	getPixelFormat ()
	Gets the pixel format of the texture. More...
local	getPixelFormat ()
	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...
var	getPixelsHigh ()
	Gets the height of the texture in pixels. More...
local	getPixelsHigh ()
	Gets the height of the texture in pixels. More...
GLuint	getName () const
	Gets the texture name. More...
var	getName ()
	Gets the texture name. More...
local	getName ()
	Gets the texture name. More...
GLfloat	getMaxS () const
	Gets max S. More...
var	getMaxS ()
	Gets max S. More...
local	getMaxS ()
	Gets max S. More...
void	setMaxS (GLfloat maxS)
	Sets max S. More...
var	setMaxS ( var maxS)
	Sets max S. More...
local	setMaxS ( local maxS)
	Sets max S. More...
GLfloat	getMaxT () const
	Gets max T. More...
var	getMaxT ()
	Gets max T. More...
local	getMaxT ()
	Gets max T. More...
void	setMaxT (GLfloat maxT)
	Sets max T. More...
Size	getContentSize () const
	Get the texture content size. More...
var	getContentSize ()
	Get the texture content size. More...
local	getContentSize ()
	Get the texture content size. More...
void	setGLProgram (GLProgram *program)
	Set a shader program to the texture. More...
var	setGLProgram ( var program)
	Set a shader program to the texture. More...
local	setGLProgram ( local program)
	Set a shader program to the texture. More...
GLProgram *	getGLProgram () const
	Get a shader program from the texture. More...
var	getGLProgram ()
	Get a shader program from the texture. More...
local	getGLProgram ()
	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...
local	setDefaultAlphaPixelFormat ( local 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 ()
local	defaultAlphaPixelFormat ()
static void	PVRImagesHavePremultipliedAlpha (bool haveAlphaPremultiplied)
	Treats (or not) PVR files as if they have alpha premultiplied. More...
local	PVRImagesHavePremultipliedAlpha ( local 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...
local	getPixelFormatInfoMap ()
	Get pixel info map, the key-value pairs is PixelFormat and PixelFormatInfo. More...

Protected Attributes
Texture2D::PixelFormat	_pixelFormat
	pixel format of the texture More...
int	_pixelsWide
	width in pixels More...
var	_pixelsWide
	width in pixels More...
local	_pixelsWide
	width in pixels More...
int	_pixelsHigh
	height in pixels More...
var	_pixelsHigh
	height in pixels More...
local	_pixelsHigh
	height in pixels More...
GLuint	_name
	texture name More...
var	_name
	texture name More...
local	_name
	texture name More...
GLfloat	_maxS
	texture max S More...
var	_maxS
	texture max S More...
local	_maxS
	texture max S More...
GLfloat	_maxT
	texture max T More...
var	_maxT
	texture max T More...
local	_maxT
	texture max T More...
Size	_contentSize
	content size More...
var	_contentSize
	content size More...
local	_contentSize
	content size More...
bool	_hasPremultipliedAlpha
	whether or not the texture has their Alpha premultiplied More...
var	_hasPremultipliedAlpha
	whether or not the texture has their Alpha premultiplied More...
local	_hasPremultipliedAlpha
	whether or not the texture has their Alpha premultiplied More...
bool	_hasMipmaps
	whether or not the texture has mip maps More...
GLProgram *	_shaderProgram
	shader program used by drawAtPoint and drawInRect More...
var	_shaderProgram
	shader program used by drawAtPoint and drawInRect More...
local	_shaderProgram
	shader program used by drawAtPoint and drawInRect More...
bool	_antialiasEnabled
var	_antialiasEnabled
local	_antialiasEnabled
Protected Attributes inherited from Ref
unsigned int	_referenceCount
	count of references More...
local	_referenceCount
	count of references More...

Static Protected Attributes
static const PixelFormatInfoMap	_pixelFormatInfoTables
var	_pixelFormatInfoTables
local	_pixelFormatInfoTables

Additional Inherited Members
Protected Member Functions inherited from Ref
	Ref ()
	Constructor. More...
	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

var PixelFormatInfoMap

local PixelFormatInfoMap

Constructor & Destructor Documentation

Texture2D

(

)

var ctor

(

)

local Texture2D

(

)

virtual ~Texture2D ( )

virtual

Member Function Documentation

unsigned int bitsPerPixelForFormat ( ) const

inline

var bitsPerPixelForFormat ( )

inline

local bitsPerPixelForFormat ( )

inline

unsigned int bitsPerPixelForFormat ( Texture2D::PixelFormat  format ) const

inline

var bitsPerPixelForFormat ( var  format )

inline

local bitsPerPixelForFormat ( local  format )

inline

static Texture2D::PixelFormat defaultAlphaPixelFormat ( )

inlinestatic

var defaultAlphaPixelFormat ( )

inlinestatic

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

var drawAtPoint

(

var

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.

local drawAtPoint

(

local

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.

var drawInRect

(

var

rect

)

Draws a texture inside a rect.

local drawInRect

(

local

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

var generateMipmap

(

)

Generates mipmap images for the texture.

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

Since

v0.99.0

local 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

var getBitsPerPixelForFormat

(

)

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

Since

v1.0

local getBitsPerPixelForFormat

(

)

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

var getBitsPerPixelForFormat

(

var

format

)

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

Since

v2.0

local getBitsPerPixelForFormat

(

local

format

)

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

Since

v2.0

Size getContentSize

(

)

const

Get the texture content size.

var getContentSize

(

)

Get the texture content size.

local getContentSize

(

)

Get the texture content size.

const Size& getContentSizeInPixels

(

)

Get content size.

var getContentSizeInPixels

(

)

Get content size.

local getContentSizeInPixels

(

)

Get content size.

static Texture2D::PixelFormat getDefaultAlphaPixelFormat ( )

static

Returns the alpha pixel format.

Since

v0.8

var getDefaultAlphaPixelFormat ( )

static

Returns the alpha pixel format.

Since

v0.8

local getDefaultAlphaPixelFormat ( )

static

Returns the alpha pixel format.

Since

v0.8

virtual std::string getDescription ( ) const

virtual

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

GLProgram* getGLProgram

(

)

const

Get a shader program from the texture.

var getGLProgram

(

)

Get a shader program from the texture.

local getGLProgram

(

)

Get a shader program from the texture.

GLfloat getMaxS

(

)

const

Gets max S.

var getMaxS

(

)

Gets max S.

local getMaxS

(

)

Gets max S.

GLfloat getMaxT

(

)

const

Gets max T.

var getMaxT

(

)

Gets max T.

local getMaxT

(

)

Gets max T.

GLuint getName

(

)

const

Gets the texture name.

var getName

(

)

Gets the texture name.

local getName

(

)

Gets the texture name.

Texture2D::PixelFormat getPixelFormat

(

)

const

Gets the pixel format of the texture.

var getPixelFormat

(

)

Gets the pixel format of the texture.

local getPixelFormat

(

)

Gets the pixel format of the texture.

static const PixelFormatInfoMap& getPixelFormatInfoMap ( )

static

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

var getPixelFormatInfoMap ( )

static

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

local getPixelFormatInfoMap ( )

static

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

int getPixelsHigh

(

)

const

Gets the height of the texture in pixels.

var getPixelsHigh

(

)

Gets the height of the texture in pixels.

local getPixelsHigh

(

)

Gets the height of the texture in pixels.

int getPixelsWide

(

)

const

Gets the width of the texture in pixels.

var getPixelsWide

(

)

Gets the width of the texture in pixels.

local getPixelsWide

(

)

Gets the width of the texture in pixels.

const char* getStringForFormat

(

)

const

Returns the pixel format.

Since

v2.0

var getStringForFormat

(

)

Returns the pixel format.

Since

v2.0

local getStringForFormat

(

)

Returns the pixel format.

Since

v2.0

bool hasMipmaps

(

)

const

Whether or not the texture has mip maps.

var hasMipmaps

(

)

Whether or not the texture has mip maps.

local hasMipmaps

(

)

Whether or not the texture has mip maps.

bool hasPremultipliedAlpha

(

)

const

Whether or not the texture has their Alpha premultiplied.

var hasPremultipliedAlpha

(

)

Whether or not the texture has their Alpha premultiplied.

local hasPremultipliedAlpha

(

)

Whether or not the texture has their Alpha premultiplied.

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.

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.

var initWithImage

(

var

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.

local initWithImage

(

local

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.

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.

var initWithImage	(	var	image,
		var	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.

local initWithImage	(	local	image,
		local	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.

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.

var initWithMipmaps	(	var	mipmaps,
		var	mipmapsNum,
		var	pixelFormat,
		var	pixelsWide,
		var	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.

local initWithMipmaps	(	local	mipmaps,
		local	mipmapsNum,
		local	pixelFormat,
		local	pixelsWide,
		local	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.

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.

Parameters

text	A null terminated string.
fontName	The font name.
dimensions	The font dimension.
hAlignment	The font horizontal text alignment type.
vAlignment	The font vertical text alignment type.

var initWithString	(	var	text,
		var	fontName,
		var	fontSize,
		var	dimensions = Size(0, 0),
		var	hAlignment = TextHAlignment::CENTER,
		var	vAlignment = TextVAlignment::TOP
	)

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

Parameters

text	A null terminated string.
fontName	The font name.
dimensions	The font dimension.
hAlignment	The font horizontal text alignment type.
vAlignment	The font vertical text alignment type.

local initWithString	(	local	text,
		local	fontName,
		local	fontSize,
		local	dimensions = Size(0, 0),
		local	hAlignment = TextHAlignment::CENTER,
		local	vAlignment = TextVAlignment::TOP
	)

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

Parameters

text	A null terminated string.
fontName	The font name.
dimensions	The font dimension.
hAlignment	The font horizontal text alignment type.
vAlignment	The font vertical text alignment type.

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.

var initWithString	(	var	text,
		var	textDefinition
	)

Initializes a texture from a string using a text definition.

Parameters

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

local initWithString	(	local	text,
		local	textDefinition
	)

Initializes a texture from a string using a text definition.

Parameters

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

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

var PVRImagesHavePremultipliedAlpha ( var  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

local PVRImagesHavePremultipliedAlpha ( local  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

void releaseGLTexture

(

)

Release only the gl texture.

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

var 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

local 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

var 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

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

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

var setDefaultAlphaPixelFormat ( var  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

local setDefaultAlphaPixelFormat ( local  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

void setGLProgram

(

GLProgram *

program

)

Set a shader program to the texture.

It's used by drawAtPoint and drawInRect

var setGLProgram

(

var

program

)

Set a shader program to the texture.

It's used by drawAtPoint and drawInRect

local setGLProgram

(

local

program

)

Set a shader program to the texture.

It's used by drawAtPoint and drawInRect

void setMaxS

(

GLfloat

maxS

)

Sets max S.

var setMaxS

(

var

maxS

)

Sets max S.

local setMaxS

(

local

maxS

)

Sets max S.

void setMaxT

(

GLfloat

maxT

)

Sets max T.

var setMaxT

(

var

maxT

)

Sets max T.

local setMaxT

(

local

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)

var setTexParameters

(

var

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)

local setTexParameters

(

local

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

const char* stringForFormat ( ) const

inline

var stringForFormat ( )

inline

local stringForFormat ( )

inline

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.

var updateWithData	(	var	data,
		var	offsetX,
		var	offsetY,
		var	width,
		var	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.

local updateWithData	(	local	data,
		local	offsetX,
		local	offsetY,
		local	width,
		local	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.

Member Data Documentation

bool _antialiasEnabled

protected

var _antialiasEnabled

protected

local _antialiasEnabled

protected

Size _contentSize

protected

content size

var _contentSize

protected

content size

local _contentSize

protected

content size

bool _hasMipmaps

protected

whether or not the texture has mip maps

var _hasMipmaps

protected

whether or not the texture has mip maps

local _hasMipmaps

protected

whether or not the texture has mip maps

bool _hasPremultipliedAlpha

protected

whether or not the texture has their Alpha premultiplied

var _hasPremultipliedAlpha

protected

whether or not the texture has their Alpha premultiplied

local _hasPremultipliedAlpha

protected

whether or not the texture has their Alpha premultiplied

GLfloat _maxS

protected

texture max S

var _maxS

protected

texture max S

local _maxS

protected

texture max S

GLfloat _maxT

protected

texture max T

var _maxT

protected

texture max T

local _maxT

protected

texture max T

GLuint _name

protected

texture name

var _name

protected

texture name

local _name

protected

texture name

Texture2D::PixelFormat _pixelFormat

protected

pixel format of the texture

const PixelFormatInfoMap _pixelFormatInfoTables

staticprotected

var _pixelFormatInfoTables

staticprotected

local _pixelFormatInfoTables

staticprotected

int _pixelsHigh

protected

height in pixels

var _pixelsHigh

protected

height in pixels

local _pixelsHigh

protected

height in pixels

int _pixelsWide

protected

width in pixels

var _pixelsWide

protected

width in pixels

local _pixelsWide

protected

width in pixels

GLProgram* _shaderProgram

protected

shader program used by drawAtPoint and drawInRect

var _shaderProgram

protected

shader program used by drawAtPoint and drawInRect

local _shaderProgram

protected

shader program used by drawAtPoint and drawInRect

---

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

• /Users/minggo/SourceCode/cocos2d-x/cocos/renderer/CCTexture2D.h