#include <CCGLViewProtocol.h>

Inheritance diagram for GLViewProtocol:

Public Member Functions
	GLViewProtocol ()
virtual	~GLViewProtocol ()
virtual void	end ()=0
	Force destroying EGL view, subclass must implement this method. More...

var	end ()
	Force destroying EGL view, subclass must implement this method. More...

local	end ()
	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...

local	isOpenGLReady ()
	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...

local	setIMEKeyboardState ( local open)
	Open or close IME keyboard , subclass must implement this method. More...

virtual void	pollInputEvents ()
	Polls input events. More...

virtual const Size &	getFrameSize () const
	Get the frame size of EGL view. More...

virtual void	setFrameSize (float width, float height)
	Set the frame size of EGL view. More...

local	setFrameSize ( local width, local height)
	Set the frame size of EGL view. More...

virtual Size	getVisibleSize () const
	Get the visible area size of opengl viewport. More...

var	getVisibleSize ()
	Get the visible area size of opengl viewport. More...

local	getVisibleSize ()
	Get the visible area size of opengl viewport. More...

virtual Point	getVisibleOrigin () const
	Get the visible origin point of opengl viewport. More...

local	getVisibleOrigin ()
	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...

local	setDesignResolutionSize ( local width, local height, local resolutionPolicy)
	Set the design resolution size. More...

virtual const Size &	getDesignResolutionSize () 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...

local	setViewPortInPoints ( local x, local y, local w, local 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...

local	setScissorInPoints ( local x, local y, local w, local 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)
local	setViewName ( local 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[])
local	handleTouchesMove ( local num)
virtual void	handleTouchesEnd (int num, intptr_t ids[], float xs[], float ys[])
local	handleTouchesEnd ( local num)
virtual void	handleTouchesCancel (int num, intptr_t ids[], float xs[], float ys[])
local	handleTouchesCancel ( local num)
const Rect &	getViewPortRect () 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...

local	getScaleY ()
	Get scale factor of the vertical direction. More...

ResolutionPolicy	getResolutionPolicy () const
	returns the current Resolution policy More...

local	getResolutionPolicy ()
	returns the current Resolution policy More...

Protected Member Functions
void	updateDesignResolutionSize ()
var	updateDesignResolutionSize ()
local	updateDesignResolutionSize ()
void	handleTouchesOfEndOrCancel (EventTouch::EventCode eventCode, int num, intptr_t ids[], float xs[], float ys[])
var	handleTouchesOfEndOrCancel ( var eventCode, var num)
local	handleTouchesOfEndOrCancel ( local eventCode, local num)

Protected Attributes
Size	_screenSize
Size	_designResolutionSize
var	_designResolutionSize
local	_designResolutionSize
Rect	_viewPortRect
std::string	_viewName
var	_viewName
local	_viewName
float	_scaleX
float	_scaleY
ResolutionPolicy	_resolutionPolicy
var	_resolutionPolicy
local	_resolutionPolicy

Constructor & Destructor Documentation

GLViewProtocol ( )

var ctor ( )

local GLViewProtocol ( )

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.

var end ( )

pure virtual

Force destroying EGL view, subclass must implement this method.

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

local 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'.

var getDesignResolutionSize ( )

virtual

Get design resolution size.

Default resolution size is the same as 'getFrameSize'.

local getDesignResolutionSize ( )

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.

var getFrameSize ( )

virtual

Get the frame size of EGL view.

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

local getFrameSize ( )

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

var getResolutionPolicy ( )

inline

returns the current Resolution policy

local getResolutionPolicy ( )

inline

returns the current Resolution policy

float getScaleX ( ) const

Get scale factor of the horizontal direction.

var getScaleX ( )

Get scale factor of the horizontal direction.

local getScaleX ( )

Get scale factor of the horizontal direction.

float getScaleY ( ) const

Get scale factor of the vertical direction.

var getScaleY ( )

Get scale factor of the vertical direction.

local getScaleY ( )

Get scale factor of the vertical direction.

virtual Rect getScissorRect ( ) const

virtual

Get the current scissor rectangle.

var getScissorRect ( )

virtual

Get the current scissor rectangle.

local getScissorRect ( )

virtual

Get the current scissor rectangle.

const std::string& getViewName ( ) const

var getViewName ( )

local getViewName ( )

const Rect& getViewPortRect ( ) const

Get the opengl view port rectangle.

var getViewPortRect ( )

Get the opengl view port rectangle.

local getViewPortRect ( )

Get the opengl view port rectangle.

virtual Point getVisibleOrigin ( ) const

virtual

Get the visible origin point of opengl viewport.

var getVisibleOrigin ( )

virtual

Get the visible origin point of opengl viewport.

local getVisibleOrigin ( )

virtual

Get the visible origin point of opengl viewport.

virtual Rect getVisibleRect ( ) const

virtual

Get the visible rectangle of opengl viewport.

var getVisibleRect ( )

virtual

Get the visible rectangle of opengl viewport.

local getVisibleRect ( )

virtual

Get the visible rectangle of opengl viewport.

virtual Size getVisibleSize ( ) const

virtual

Get the visible area size of opengl viewport.

var getVisibleSize ( )

virtual

Get the visible area size of opengl viewport.

local getVisibleSize ( )

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:

var handleTouchesBegin	(	var	num,
		var	ids[],
		var	xs[],
		var	ys[]
	)

virtual

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

local handleTouchesBegin	(	local	num,
		local	ids[],
		local	xs[],
		local	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

var handleTouchesCancel	(	var	num,
		var	ids[],
		var	xs[],
		var	ys[]
	)

virtual

local handleTouchesCancel	(	local	num,
		local	ids[],
		local	xs[],
		local	ys[]
	)

virtual

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

virtual

var handleTouchesEnd	(	var	num,
		var	ids[],
		var	xs[],
		var	ys[]
	)

virtual

local handleTouchesEnd	(	local	num,
		local	ids[],
		local	xs[],
		local	ys[]
	)

virtual

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

virtual

var handleTouchesMove	(	var	num,
		var	ids[],
		var	xs[],
		var	ys[]
	)

virtual

local handleTouchesMove	(	local	num,
		local	ids[],
		local	xs[],
		local	ys[]
	)

virtual

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

protected

var handleTouchesOfEndOrCancel	(	var	eventCode,
		var	num,
		var	ids[],
		var	xs[],
		var	ys[]
	)

protected

local handleTouchesOfEndOrCancel	(	local	eventCode,
		local	num,
		local	ids[],
		local	xs[],
		local	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.

var isOpenGLReady ( )

pure virtual

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

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

local 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.

var isScissorEnabled ( )

virtual

Get whether GL_SCISSOR_TEST is enable.

local 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.

var pollInputEvents ( )

virtual

Polls input events.

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

local 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

width	Design resolution width.
height	Design resolution height.
resolutionPolicy	The 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.

var setDesignResolutionSize	(	var	width,
		var	height,
		var	resolutionPolicy
	)

virtual

Set the design resolution size.

Parameters

width	Design resolution width.
height	Design resolution height.
resolutionPolicy	The 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.

local setDesignResolutionSize	(	local	width,
		local	height,
		local	resolutionPolicy
	)

virtual

Set the design resolution size.

Parameters

width	Design resolution width.
height	Design resolution height.
resolutionPolicy	The 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.

var setFrameSize	(	var	width,
		var	height
	)

virtual

Set the frame size of EGL view.

Reimplemented in GLView, and GLView.

local setFrameSize	(	local	width,
		local	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.

var setIMEKeyboardState ( var open)

pure virtual

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

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

local setIMEKeyboardState ( local 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.

var setScissorInPoints	(	var	x,
		var	y,
		var	w,
		var	h
	)

virtual

Set Scissor rectangle with points.

Reimplemented in GLView, and GLView.

local setScissorInPoints	(	local	x,
		local	y,
		local	w,
		local	h
	)

virtual

Set Scissor rectangle with points.

Reimplemented in GLView, and GLView.

virtual void setViewName ( const std::string & viewname)

virtual

var setViewName ( var viewname)

virtual

local setViewName ( local 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.

var setViewPortInPoints	(	var	x,
		var	y,
		var	w,
		var	h
	)

virtual

Set opengl view port rectangle with points.

Reimplemented in GLView, and GLView.

local setViewPortInPoints	(	local	x,
		local	y,
		local	w,
		local	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.

var swapBuffers ( )

pure virtual

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

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

local 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

var updateDesignResolutionSize ( )

protected

local updateDesignResolutionSize ( )

protected

Member Data Documentation

Size _designResolutionSize

protected

var _designResolutionSize

protected

local _designResolutionSize

protected

ResolutionPolicy _resolutionPolicy

protected

var _resolutionPolicy

protected

local _resolutionPolicy

protected

float _scaleX

protected

var _scaleX

protected

local _scaleX

protected

float _scaleY

protected

var _scaleY

protected

local _scaleY

protected

Size _screenSize

protected

std::string _viewName

protected

var _viewName

protected

local _viewName

protected

Rect _viewPortRect

protected

var _viewPortRect

protected

local _viewPortRect

protected

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

/Users/cocos2d/MyWork/cocos2d-x-develop/cocos/2d/platform/CCGLViewProtocol.h

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation