VgEAGLView Class Reference

This class wraps the CAEAGLLayer from CoreAnimation into a convenient UIView subclass its superclass VgEAGLBaseView contains most important methods. More...

Inheritance diagram for VgEAGLView:

Instance Methods
(id)	- initWithFrame:
	Creates a new VgEAGLView and as well as setting itself as the current context. More...
(id)	- initWithFrame:pixelFormat:
(id)	- initWithFrame:pixelFormat:depthFormat:preserveBackbuffer:
(void)	- startAnimation
	Responsible for creating the VisioMove application. More...
(void)	- renderScene
	refreshes the screen. More...
Instance Methods inherited from VgEAGLBaseView
(void)	- setRenderSuspended:
	A Boolean indicating whether the EAGL View is rendered. More...
(BOOL)	- getRenderSuspended
(void)	- setUpdateSuspended:
	A Boolean indicating whether the EAGL View is updated, this is different from rendering. More...
(BOOL)	- getUpdateSuspended
(UIImage *)	- captureToImage
	Captures the current GL Buffer and creates a UIImage If VgEAGLView does not have preserveBackbuffer, this will be enabled during the call and then reset. More...
(void)	- notifyDidReceiveMemoryWarning
	Notifies the view when the application receives a memory warning from the system. More...
(BOOL)	- multisample
	Tells the application if multisample is enabled or not. More...
(void)	- setMultisample:
	enables/disabling multisampling (to reduce anti-aliasing) More...
(BOOL)	- preserveBackbuffer
	Tells the application if preserveBackbuffer is enabled or not. More...
(void)	- setPreserveBackbuffer:
	enables/disabling preserveBackbuffer (to be able to use captureToImage) More...
(void)	- setRenderOnDemand:
	enables/disabling renderOnDemand. More...
(BOOL)	- renderOnDemand
	Tells the application if renderOnDemand is enabled or not, default is YES. More...
(NSInteger)	- frameInterval
	Returns current value for the frameInterval property which defined how many frames to skip before rendering a frame. More...
(void)	- setFrameInterval:
	Allows the VgEAGLView to reduce the frame rate, by rendering a frame every "frameInterval" frames. More...

Additional Inherited Members
Properties inherited from VgEAGLBaseView
UIInterfaceOrientation	mInterfaceOrientation
	The current orientation of the VgEAGLView. More...
VgApplication::VgIApplication *	mApp
	The entry point to the VisioMove. More...

Detailed Description

This class wraps the CAEAGLLayer from CoreAnimation into a convenient UIView subclass its superclass VgEAGLBaseView contains most important methods.

The view content is basically an EAGL surface you render your OpenGL scene into.

Method Documentation

- (id) initWithFrame:

(CGRect)

frame

Creates a new VgEAGLView and as well as setting itself as the current context.

By default multiple touch support on the view is enabled. The default orientation is UIInterfaceOrientationPortrait.

Note

If not stipulated, the following defaults are used; pixel format set to kEAGLColorFormatRGBA8, depth format set to GL_DEPTH_COMPONENT16_OES and the preserve back buffer is disabled.

Parameters

frame

- default frame size of the view

Returns

A newly initialized VgEAGLView.

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

- (id) initWithFrame:		(CGRect)	frame
pixelFormat:		(NSString *)	format
depthFormat:		(unsigned int)	depth
preserveBackbuffer:		(BOOL)	retained

- (void) renderScene

refreshes the screen.

Note

This function is not generally called by the user, except in cases where they absolutely need the screen to be refreshed, or to trigger a post renderscene callback for example.

- (void) startAnimation

Responsible for creating the VisioMove application.

This means it will call VgApplication::VgIApplication::createApplication on your behalf as well as initiating the animation timer responsible for invoking the render scene.

Implements VgEAGLBaseView.

---

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

• VgEAGLView.h