cocos2d-iphone  2.1
Improved Cocos2D API Reference (iOS version) for www.kobold2d.com developers
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Properties Defines
CCGLView Class Reference

#import <CCGLView.h>

+ Inheritance diagram for CCGLView:

List of all members.

Public Member Functions

(id) - initWithFrame:
(id) - initWithFrame:pixelFormat:
(id) - initWithFrame:pixelFormat:depthFormat:preserveBackbuffer:sharegroup:multiSampling:numberOfSamples:
(void) - swapBuffers
(void) - lockOpenGLContext
(void) - unlockOpenGLContext
(CGPoint) - convertPointFromViewToSurface:
(CGRect) - convertRectFromViewToSurface:

Static Public Member Functions

(id) + viewWithFrame:
(id) + viewWithFrame:pixelFormat:
(id) + viewWithFrame:pixelFormat:depthFormat:
(id) + viewWithFrame:pixelFormat:depthFormat:preserveBackbuffer:sharegroup:multiSampling:numberOfSamples:

Protected Attributes

id< CCESRenderer_renderer
EAGLContext * _context
NSString * _pixelformat
GLuint _depthFormat
BOOL _preserveBackbuffer
CGSize _size
BOOL _discardFramebufferSupported
id< CCTouchDelegate_touchDelegate
BOOL _multisampling
unsigned int _requestedSamples

Properties

NSString * pixelFormat
GLuint depthFormat
CGSize surfaceSize
EAGLContext * context
BOOL multiSampling
id< CCTouchDelegatetouchDelegate

Detailed Description

CCGLView Class. This class wraps the CAEAGLLayer from CoreAnimation into a convenient UIView subclass. The view content is basically an EAGL surface you render your OpenGL scene into. Note that setting the view non-opaque will only work if the EAGL surface has an alpha channel.


Member Function Documentation

- (id) initWithFrame: (CGRect)  frame

Initializes an CCGLView with a frame and 0-bit depth buffer, and a RGB565 color buffer

- (id) initWithFrame: (CGRect)  frame
pixelFormat: (NSString *)  format 

Initializes an CCGLView with a frame, a color buffer format, and 0-bit depth buffer

- (id) initWithFrame: (CGRect)  frame
pixelFormat: (NSString *)  format
depthFormat: (GLuint)  depth
preserveBackbuffer: (BOOL)  retained
sharegroup: (EAGLSharegroup *)  sharegroup
multiSampling: (BOOL)  sampling
numberOfSamples: (unsigned int)  nSamples 

Initializes an CCGLView with a frame, a color buffer format, a depth buffer format, a sharegroup and multisampling support

uses and locks the OpenGL context

- (void) swapBuffers

CCGLView uses double-buffer. This method swaps the buffers

unlocks the openGL context

+ (id) viewWithFrame: (CGRect)  frame

creates an initializes an CCGLView with a frame and 0-bit depth buffer, and a RGB565 color buffer.

+ (id) viewWithFrame: (CGRect)  frame
pixelFormat: (NSString *)  format 

creates an initializes an CCGLView with a frame, a color buffer format, and 0-bit depth buffer.

+ (id) viewWithFrame: (CGRect)  frame
pixelFormat: (NSString *)  format
depthFormat: (GLuint)  depth 

creates an initializes an CCGLView with a frame, a color buffer format, and a depth buffer.

+ (id) viewWithFrame: (CGRect)  frame
pixelFormat: (NSString *)  format
depthFormat: (GLuint)  depth
preserveBackbuffer: (BOOL)  retained
sharegroup: (EAGLSharegroup *)  sharegroup
multiSampling: (BOOL)  multisampling
numberOfSamples: (unsigned int)  samples 

creates an initializes an CCGLView with a frame, a color buffer format, a depth buffer format, a sharegroup, and multisamping


Property Documentation

- (EAGLContext*) context [read, assign]

OpenGL context

- (GLuint) depthFormat [read, assign]

depth format of the render buffer: 0, 16 or 24 bits

- (NSString*) pixelFormat [read, assign]

pixel format: it could be RGBA8 (32-bit) or RGB565 (16-bit)

- (CGSize) surfaceSize [read, assign]

returns surface size in pixels

- (id<CCTouchDelegate>) touchDelegate [read, write, assign]

touch delegate


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