VisioDevKit  v2.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties Friends Pages
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:
Inheritance graph

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 VisioDevKit application. More...
 
(void) - renderScene
 refreshes the screen. More...
 
- Instance Methods inherited from VgEAGLBaseView
(UIImage *) - captureToImage
 
(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. More...
 

Additional Inherited Members

- Properties inherited from VgEAGLBaseView
BOOL mRenderOnDemand
 
BOOL mRenderSuspended
 A Boolean indicating whether the EAGL View is rendered. More...
 
BOOL mUpdateSuspended
 A Boolean indicating whether the EAGL View is updated, this is different from rendering. More...
 
UIInterfaceOrientation mInterfaceOrientation
 The current orientation of the VgEAGLView. More...
 
VgApplication::VgIApplicationmApp
 The entry point to the VisioDevKit. 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.

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 VisioDevKit 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:
VisioDevKit 2.0, Visioglobe® 2013