cocos2d-x  3.1rc0
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
GLViewProtocol Class Referenceabstract

#include <CCGLViewProtocol.h>

Inheritance diagram for GLViewProtocol:
GLView GLView GLView GLView GLView

Public Member Functions

 GLViewProtocol ()
virtual ~GLViewProtocol ()
virtual void end ()=0
 Force destroying EGL view, subclass must implement this method. More...
 
virtual bool isOpenGLReady ()=0
 Get whether opengl render system is ready, subclass must implement this method. More...
 
virtual void swapBuffers ()=0
 Exchanges the front and back buffers, subclass must implement this method. More...
 
virtual void setIMEKeyboardState (bool open)=0
 Open or close IME keyboard , subclass must implement this method. More...
 
virtual void pollInputEvents ()
 Polls input events. More...
 
virtual const SizegetFrameSize () const
 Get the frame size of EGL view. More...
 
virtual void setFrameSize (float width, float height)
 Set the frame size of EGL view. More...
 
virtual Size getVisibleSize () const
 Get the visible area size of opengl viewport. More...
 
virtual Vec2 getVisibleOrigin () const
 Get the visible origin point of opengl viewport. More...
 
virtual Rect getVisibleRect () const
 Get the visible rectangle of opengl viewport. More...
 
virtual void setDesignResolutionSize (float width, float height, ResolutionPolicy resolutionPolicy)
 Set the design resolution size. More...
 
virtual const SizegetDesignResolutionSize () const
 Get design resolution size. More...
 
virtual void setViewPortInPoints (float x, float y, float w, float h)
 Set opengl view port rectangle with points. More...
 
virtual void setScissorInPoints (float x, float y, float w, float h)
 Set Scissor rectangle with points. More...
 
virtual bool isScissorEnabled ()
 Get whether GL_SCISSOR_TEST is enable. More...
 
virtual Rect getScissorRect () const
 Get the current scissor rectangle. More...
 
virtual void setViewName (const std::string &viewname)
const std::string & getViewName () const
virtual void handleTouchesBegin (int num, intptr_t ids[], float xs[], float ys[])
 Touch events are handled by default; if you want to customize your handlers, please override these functions: More...
 
virtual void handleTouchesMove (int num, intptr_t ids[], float xs[], float ys[])
virtual void handleTouchesEnd (int num, intptr_t ids[], float xs[], float ys[])
virtual void handleTouchesCancel (int num, intptr_t ids[], float xs[], float ys[])
const RectgetViewPortRect () const
 Get the opengl view port rectangle. More...
 
float getScaleX () const
 Get scale factor of the horizontal direction. More...
 
float getScaleY () const
 Get scale factor of the vertical direction. More...
 
ResolutionPolicy getResolutionPolicy () const
 returns the current Resolution policy More...
 

Protected Member Functions

void updateDesignResolutionSize ()
void handleTouchesOfEndOrCancel (EventTouch::EventCode eventCode, int num, intptr_t ids[], float xs[], float ys[])

Protected Attributes

Size _screenSize
Size _designResolutionSize
Rect _viewPortRect
std::string _viewName
float _scaleX
float _scaleY
ResolutionPolicy _resolutionPolicy

Constructor & Destructor Documentation

virtual ~GLViewProtocol ( )
virtual

Member Function Documentation

virtual void end ( )
pure virtual

Force destroying EGL view, subclass must implement this method.

Implemented in GLView, GLView, GLView, GLView, and GLView.

virtual const Size&
getDesignResolutionSize
( ) const
virtual

Get design resolution size.

Default resolution size is the same as 'getFrameSize'.

virtual const Size& getFrameSize ( ) const
virtual

Get the frame size of EGL view.

In general, it returns the screen size since the EGL view is a fullscreen view.

ResolutionPolicy
getResolutionPolicy
( ) const
inline

returns the current Resolution policy

float getScaleX ( ) const

Get scale factor of the horizontal direction.

float getScaleY ( ) const

Get scale factor of the vertical direction.

virtual Rect getScissorRect ( ) const
virtual

Get the current scissor rectangle.

const std::string& getViewName ( ) const
const Rect& getViewPortRect ( ) const

Get the opengl view port rectangle.

virtual Vec2 getVisibleOrigin ( ) const
virtual

Get the visible origin point of opengl viewport.

virtual Rect getVisibleRect ( ) const
virtual

Get the visible rectangle of opengl viewport.

virtual Size getVisibleSize ( ) const
virtual

Get the visible area size of opengl viewport.

virtual void handleTouchesBegin ( int  num,
intptr_t  ids[],
float  xs[],
float  ys[] 
)
virtual

Touch events are handled by default; if you want to customize your handlers, please override these functions:

virtual void handleTouchesCancel ( int  num,
intptr_t  ids[],
float  xs[],
float  ys[] 
)
virtual
virtual void handleTouchesEnd ( int  num,
intptr_t  ids[],
float  xs[],
float  ys[] 
)
virtual
virtual void handleTouchesMove ( int  num,
intptr_t  ids[],
float  xs[],
float  ys[] 
)
virtual
void handleTouchesOfEndOrCancel ( EventTouch::EventCode  eventCode,
int  num,
intptr_t  ids[],
float  xs[],
float  ys[] 
)
protected
virtual bool isOpenGLReady ( )
pure virtual

Get whether opengl render system is ready, subclass must implement this method.

Implemented in GLView, GLView, GLView, GLView, and GLView.

virtual bool isScissorEnabled ( )
virtual

Get whether GL_SCISSOR_TEST is enable.

virtual void pollInputEvents ( )
virtual

Polls input events.

Subclass must implement methods if platform does not provide event callbacks.

virtual void
setDesignResolutionSize
( float  width,
float  height,
ResolutionPolicy  resolutionPolicy 
)
virtual

Set the design resolution size.

Parameters
widthDesign resolution width.
heightDesign resolution height.
resolutionPolicyThe resolution policy desired, you may choose: [1] EXACT_FIT Fill screen by stretch-to-fit: if the design resolution ratio of width to height is different from the screen resolution ratio, your game view will be stretched. [2] NO_BORDER Full screen without black border: if the design resolution ratio of width to height is different from the screen resolution ratio, two areas of your game view will be cut. [3] SHOW_ALL Full screen with black border: if the design resolution ratio of width to height is different from the screen resolution ratio, two black borders will be shown.
virtual void setFrameSize ( float  width,
float  height 
)
virtual

Set the frame size of EGL view.

Reimplemented in GLView, and GLView.

virtual void setIMEKeyboardState ( bool  open)
pure virtual

Open or close IME keyboard , subclass must implement this method.

Implemented in GLView, GLView, GLView, GLView, and GLView.

virtual void setScissorInPoints ( float  x,
float  y,
float  w,
float  h 
)
virtual

Set Scissor rectangle with points.

Reimplemented in GLView, and GLView.

virtual void setViewName ( const std::string &  viewname)
virtual
virtual void setViewPortInPoints ( float  x,
float  y,
float  w,
float  h 
)
virtual

Set opengl view port rectangle with points.

Reimplemented in GLView, and GLView.

virtual void swapBuffers ( )
pure virtual

Exchanges the front and back buffers, subclass must implement this method.

Implemented in GLView, GLView, GLView, GLView, and GLView.

void updateDesignResolutionSize ( )
protected

Member Data Documentation

Size _designResolutionSize
protected
ResolutionPolicy _resolutionPolicy
protected
float _scaleX
protected
float _scaleY
protected
Size _screenSize
protected
std::string _viewName
protected
Rect _viewPortRect
protected

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