CCTexture2D Class Reference

#import <CCTexture2D.h>

Inheritance diagram for CCTexture2D:

Collaboration diagram for CCTexture2D:

Instance Methods
(id)	- initWithData:pixelFormat:pixelsWide:pixelsHigh:contentSize:
(void)	- releaseData:
(void *)	- keepData:length:
(CGSize)	- contentSize
(id)	- initWithString:dimensions:alignment:lineBreakMode:fontName:fontSize:
(id)	- initWithString:dimensions:alignment:fontName:fontSize:
(void)	- drawAtPoint:
(void)	- drawInRect:
(void)	- setTexParameters:
(void)	- setAntiAliasTexParameters
(void)	- setAliasTexParameters
(void)	- generateMipmap
(id)	- initWithCGImage:resolutionType:
(NSUInteger)	- bitsPerPixelForFormat
(NSString *)	- stringForFormat
(id)	- initWithPVRFile:
(id)	- initWithString:fontName:fontSize:dimensions:hAlignment:vAlignment:lineBreakMode:
(id)	- initWithString:fontName:fontSize:dimensions:hAlignment:vAlignment:
(id)	- initWithString:fontName:fontSize:

Class Methods
(void)	+ setDefaultAlphaPixelFormat:
(CCTexture2DPixelFormat)	+ defaultAlphaPixelFormat
(NSUInteger)	+ bitsPerPixelForFormat:
(void)	+ PVRImagesHavePremultipliedAlpha:

Protected Attributes
GLuint	_name
CGSize	_size
NSUInteger	_width
NSUInteger	_height
CCTexture2DPixelFormat	_format
GLfloat	_maxS
GLfloat	_maxT
BOOL	_hasPremultipliedAlpha
BOOL	_hasMipmaps
ccResolutionType	_resolutionType
CCGLProgram *	_shaderProgram

Properties
CCTexture2DPixelFormat	pixelFormat
NSUInteger	pixelsWide
NSUInteger	pixelsHigh
GLuint	name
CGSize	contentSizeInPixels
GLfloat	maxS
GLfloat	maxT
BOOL	hasPremultipliedAlpha
CCGLProgram *	shaderProgram
ccResolutionType	resolutionType

Detailed Description

CCTexture2D class. This class allows to easily create OpenGL 2D textures from images, text or raw data. The created CCTexture2D object will always have power-of-two dimensions. Depending on how you create the CCTexture2D 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!

Method Documentation

- (NSUInteger) bitsPerPixelForFormat

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

Since

v1.0

Provided by category CCTexture2D(PixelFormat).

+ (NSUInteger) bitsPerPixelForFormat:

(CCTexture2DPixelFormat)

format

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

Since

v2.0

Provided by category CCTexture2D(PixelFormat).

- (CGSize) contentSize

returns the content size of the texture in points

+ (CCTexture2DPixelFormat) defaultAlphaPixelFormat

returns the alpha pixel format

Since

v0.8

Provided by category CCTexture2D(PixelFormat).

- (void) drawAtPoint:

(CGPoint)

point

draws a texture at a given point

Provided by category CCTexture2D(Drawing).

- (void) drawInRect:

(CGRect)

rect

draws a texture inside a rect

Provided by category CCTexture2D(Drawing).

- (void) generateMipmap

Generates mipmap images for the texture. It only works if the texture size is POT (power of 2).

Since

v0.99.0

Provided by category CCTexture2D(GLFilter).

- (id) initWithCGImage:		(CGImageRef)	cgImage
resolutionType:		(ccResolutionType)	resolution

Initializes a texture from a CGImage object

Provided by category CCTexture2D(Image).

- (id) initWithData:		(const void *)	data
pixelFormat:		(CCTexture2DPixelFormat)	pixelFormat
pixelsWide:		(NSUInteger)	width
pixelsHigh:		(NSUInteger)	height
contentSize:		(CGSize)	size

Initializes with a texture2d with data

- (id) initWithPVRFile:

(NSString *)

file

Initializes a texture from a PVR file.

Supported PVR formats:

• BGRA 8888
• RGBA 8888
• RGBA 4444
• RGBA 5551
• RBG 565
• A 8
• I 8
• AI 8
• PVRTC 2BPP
• PVRTC 4BPP

By default PVR images are treated as if they alpha channel is NOT premultiplied. You can override this behavior with this class method:

• PVRImagesHavePremultipliedAlpha: (CCTexture2D(PVRSupport))haveAlphaPremultiplied;

IMPORTANT: This method is only defined on iOS. It is not supported on the Mac version.

Provided by category CCTexture2D(PVRSupport).

- (id) initWithString:		(NSString *)	string
fontName:		(NSString *)	name
fontSize:		(CGFloat)	size

Initializes a texture from a string with font name and font size

Provided by category CCTexture2D(Text).

- (id) initWithString:		(NSString *)	string
fontName:		(NSString *)	name
fontSize:		(CGFloat)	size
dimensions:		(CGSize)	dimensions
hAlignment:		(CCTextAlignment)	alignment
vAlignment:		(CCVerticalTextAlignment)	vertAlignment

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

Provided by category CCTexture2D(Text).

- (id) initWithString:		(NSString *)	string
fontName:		(NSString *)	name
fontSize:		(CGFloat)	size
dimensions:		(CGSize)	dimensions
hAlignment:		(CCTextAlignment)	alignment
vAlignment:		(CCVerticalTextAlignment)	vertAlignment
lineBreakMode:		(CCLineBreakMode)	lineBreakMode

Initializes a texture from a string with dimensions, alignment, line break mode, font name and font size Supported lineBreakModes:

• iOS: all UILineBreakMode supported modes
• Mac: Only NSLineBreakByWordWrapping is supported.

  Since

  v1.0

Provided by category CCTexture2D(Text).

+ (void) PVRImagesHavePremultipliedAlpha:

(BOOL)

haveAlphaPremultiplied

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.

Since

v0.99.5

Provided by category CCTexture2D(PVRSupport).

- (void) releaseData:

(void *)

data

These functions are needed to create mutable textures

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

Provided by category CCTexture2D(GLFilter).

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

Provided by category CCTexture2D(GLFilter).

+ (void) setDefaultAlphaPixelFormat:

(CCTexture2DPixelFormat)

format

sets the default pixel format for CGImages that contains alpha channel. If the CGImage contains alpha channel, then the options are:

• generate 32-bit textures: kCCTexture2DPixelFormat_RGBA8888 (default one)
• generate 16-bit textures: kCCTexture2DPixelFormat_RGBA4444
• generate 16-bit textures: kCCTexture2DPixelFormat_RGB5A1
• generate 24-bit textures: kCCTexture2DPixelFormat_RGB888 (no alpha)
• generate 16-bit textures: kCCTexture2DPixelFormat_RGB565 (no alpha)
• generate 8-bit textures: kCCTexture2DPixelFormat_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

Provided by category CCTexture2D(PixelFormat).

- (void) setTexParameters:

(ccTexParams *)

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

Provided by category CCTexture2D(GLFilter).

- (NSString*) stringForFormat

returns the pixel format in a NSString.

Since

v2.0

Provided by category CCTexture2D(PixelFormat).

Property Documentation

- (CGSize) contentSizeInPixels

readnonatomicassign

returns content size of the texture in pixels

- (BOOL) hasPremultipliedAlpha

readnonatomicassign

whether or not the texture has their Alpha premultiplied

- (GLfloat) maxS

readwritenonatomicassign

texture max S

- (GLfloat) maxT

readwritenonatomicassign

texture max T

- (GLuint) name

readnonatomicassign

texture name

- (CCTexture2DPixelFormat) pixelFormat

readnonatomicassign

pixel format of the texture

- (NSUInteger) pixelsHigh

readnonatomicassign

hight in pixels

- (NSUInteger) pixelsWide

readnonatomicassign

width in pixels

- (ccResolutionType) resolutionType

readwritenonatomicassign

Returns the resolution type of the texture. Is it a RetinaDisplay texture, an iPad texture, a Mac, a Mac RetinaDisplay or an standard texture ?

Should be a readonly property. It is readwrite as a hack.

Since

v1.1

- (CCGLProgram*) shaderProgram

readwritenonatomicretain

shader program used by drawAtPoint and drawInRect

---

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

• CCTexture2D.h