Configuration Class Reference

Configuration contains some openGL variables. More...

#include <CCConfiguration.h>

Inheritance diagram for Configuration:

Public Member Functions
virtual	~Configuration ()
	Destructor. More...
int	getMaxTextureSize () const
	OpenGL Max texture size. More...
local	getMaxTextureSize ()
	OpenGL Max texture size. More...
int	getMaxModelviewStackDepth () const
	OpenGL Max Modelview Stack Depth. More...
local	getMaxModelviewStackDepth ()
	OpenGL Max Modelview Stack Depth. More...
int	getMaxTextureUnits () const
	Returns the maximum texture units. More...
local	getMaxTextureUnits ()
	Returns the maximum texture units. More...
bool	supportsNPOT () const
	Whether or not the GPU supports NPOT (Non Power Of Two) textures. More...
bool	supportsPVRTC () const
	Whether or not PVR Texture Compressed is supported. More...
bool	supportsETC () const
	Whether or not ETC Texture Compressed is supported. More...
local	supportsETC ()
	Whether or not ETC Texture Compressed is supported. More...
bool	supportsS3TC () const
	Whether or not S3TC Texture Compressed is supported. More...
local	supportsS3TC ()
	Whether or not S3TC Texture Compressed is supported. More...
bool	supportsATITC () const
	Whether or not ATITC Texture Compressed is supported. More...
local	supportsATITC ()
	Whether or not ATITC Texture Compressed is supported. More...
bool	supportsBGRA8888 () const
	Whether or not BGRA8888 textures are supported. More...
local	supportsBGRA8888 ()
	Whether or not BGRA8888 textures are supported. More...
bool	supportsDiscardFramebuffer () const
	Whether or not glDiscardFramebufferEXT is supported. More...
bool	supportsShareableVAO () const
	Whether or not shareable VAOs are supported. More...
int	getMaxSupportDirLightInShader () const
	Max support directional light in shader, for Sprite3D. More...
int	getMaxSupportPointLightInShader () const
	Max support point light in shader, for Sprite3D. More...
int	getMaxSupportSpotLightInShader () const
	Max support spot light in shader, for Sprite3D. More...
local	getMaxSupportSpotLightInShader ()
	Max support spot light in shader, for Sprite3D. More...
bool	checkForGLExtension (const std::string &searchName) const
	Returns whether or not an OpenGL is supported. More...
bool	init ()
	Initialize method. More...
const Value &	getValue (const std::string &key, const Value &defaultValue=Value::Null) const
	Returns the value of a given key as a double. More...
void	setValue (const std::string &key, const Value &value)
	Sets a new key/value pair in the configuration dictionary. More...
std::string	getInfo () const
	Returns the Configuration info. More...
void	gatherGPUInfo ()
	Gathers OpenGL / GPU information. More...
local	gatherGPUInfo ()
	Gathers OpenGL / GPU information. More...
void	loadConfigFile (const std::string &filename)
	Loads a config file. More...
local	loadConfigFile ( local filename)
	Loads a config file. More...
Public Member Functions inherited from Ref
void	retain ()
	Retains the ownership. More...
void	release ()
	Releases the ownership immediately. More...
Ref *	autorelease ()
	Releases the ownership sometime soon automatically. More...
unsigned int	getReferenceCount () const
	Returns the Ref's current reference count. More...
virtual	~Ref ()
	Destructor. More...

Static Public Member Functions
static Configuration *	getInstance ()
	Returns a shared instance of Configuration. More...
local	getInstance ()
	Returns a shared instance of Configuration. More...
static void	destroyInstance ()
	Purge the shared instance of Configuration. More...
local	destroyInstance ()
	Purge the shared instance of Configuration. More...
static Configuration *	sharedConfiguration ()
local	sharedConfiguration ()
static void	purgeConfiguration ()

Protected Attributes
GLint	_maxTextureSize
local	_maxTextureSize
GLint	_maxModelviewStackDepth
local	_maxModelviewStackDepth
bool	_supportsPVRTC
local	_supportsPVRTC
bool	_supportsETC1
local	_supportsETC1
bool	_supportsS3TC
local	_supportsS3TC
bool	_supportsATITC
local	_supportsATITC
bool	_supportsNPOT
local	_supportsNPOT
bool	_supportsBGRA8888
local	_supportsBGRA8888
bool	_supportsDiscardFramebuffer
local	_supportsDiscardFramebuffer
bool	_supportsShareableVAO
local	_supportsShareableVAO
GLint	_maxSamplesAllowed
local	_maxSamplesAllowed
GLint	_maxTextureUnits
local	_maxTextureUnits
char *	_glExtensions
local	_glExtensions
int	_maxDirLightInShader
local	_maxDirLightInShader
int	_maxPointLightInShader
local	_maxPointLightInShader
int	_maxSpotLightInShader
local	_maxSpotLightInShader
ValueMap	_valueDict
local	_valueDict
Protected Attributes inherited from Ref
unsigned int	_referenceCount
	count of references More...
local	_referenceCount
	count of references More...

Additional Inherited Members
Protected Member Functions inherited from Ref
	Ref ()
	Constructor. More...
	Ref ()
	Constructor. More...

Detailed Description

Configuration contains some openGL variables.

Since

v0.99.0

Constructor & Destructor Documentation

virtual ~Configuration ( )

virtual

Destructor.

Member Function Documentation

bool checkForGLExtension

(

const std::string &

searchName

)

const

Returns whether or not an OpenGL is supported.

Parameters

searchName

A given search name.

Returns

Is true if an OpenGL is supported.

local checkForGLExtension

(

local

searchName

)

Returns whether or not an OpenGL is supported.

Parameters

searchName

A given search name.

Returns

Is true if an OpenGL is supported.

static void destroyInstance ( )

static

Purge the shared instance of Configuration.

local destroyInstance ( )

static

Purge the shared instance of Configuration.

void gatherGPUInfo

(

)

Gathers OpenGL / GPU information.

local gatherGPUInfo

(

)

Gathers OpenGL / GPU information.

std::string getInfo

(

)

const

Returns the Configuration info.

Returns

The Configuration info.

local getInfo

(

)

Returns the Configuration info.

Returns

The Configuration info.

static Configuration* getInstance ( )

static

Returns a shared instance of Configuration.

Returns

An autoreleased Configuration object.

local getInstance ( )

static

Returns a shared instance of Configuration.

Returns

An autoreleased Configuration object.

int getMaxModelviewStackDepth

(

)

const

OpenGL Max Modelview Stack Depth.

Returns

The OpenGL Max Modelview Stack Depth.

local getMaxModelviewStackDepth

(

)

OpenGL Max Modelview Stack Depth.

Returns

The OpenGL Max Modelview Stack Depth.

int getMaxSupportDirLightInShader

(

)

const

Max support directional light in shader, for Sprite3D.

Returns

Maximum supports directional light in shader.

Since

v3.3

local getMaxSupportDirLightInShader

(

)

Max support directional light in shader, for Sprite3D.

Returns

Maximum supports directional light in shader.

Since

v3.3

int getMaxSupportPointLightInShader

(

)

const

Max support point light in shader, for Sprite3D.

Returns

Maximum supports point light in shader.

Since

v3.3

local getMaxSupportPointLightInShader

(

)

Max support point light in shader, for Sprite3D.

Returns

Maximum supports point light in shader.

Since

v3.3

int getMaxSupportSpotLightInShader

(

)

const

Max support spot light in shader, for Sprite3D.

Returns

Maximum supports spot light in shader.

Since

v3.3

local getMaxSupportSpotLightInShader

(

)

Max support spot light in shader, for Sprite3D.

Returns

Maximum supports spot light in shader.

Since

v3.3

int getMaxTextureSize

(

)

const

OpenGL Max texture size.

Returns

The OpenGL Max texture size.

local getMaxTextureSize

(

)

OpenGL Max texture size.

Returns

The OpenGL Max texture size.

int getMaxTextureUnits

(

)

const

Returns the maximum texture units.

Returns

The maximum texture units.

Since

v2.0.0

local getMaxTextureUnits

(

)

Returns the maximum texture units.

Returns

The maximum texture units.

Since

v2.0.0

const Value& getValue	(	const std::string &	key,
		const Value &	defaultValue = Value::Null
	)		const

Returns the value of a given key as a double.

Parameters

key	A given key.
defaultValue	if not find the value, return the defaultValue.

Returns

local getValue	(	local	key,
		local	defaultValue = Value::Null
	)

Returns the value of a given key as a double.

Parameters

key	A given key.
defaultValue	if not find the value, return the defaultValue.

Returns

bool init

(

)

Initialize method.

Returns

Is true if initialize success.

local init

(

)

Initialize method.

Returns

Is true if initialize success.

void loadConfigFile

(

const std::string &

filename

)

Loads a config file.

If the keys are already present, then they are going to be replaced. Otherwise the new keys are added.

Parameters

filename

Config file name.

local loadConfigFile

(

local

filename

)

Loads a config file.

If the keys are already present, then they are going to be replaced. Otherwise the new keys are added.

Parameters

filename

Config file name.

static void purgeConfiguration ( )

static

Deprecated:

Use destroyInstance() instead

local purgeConfiguration ( )

static

Deprecated:

Use destroyInstance() instead

void setValue	(	const std::string &	key,
		const Value &	value
	)

Sets a new key/value pair in the configuration dictionary.

Parameters

key	A given key.
value	A given value.

local setValue	(	local	key,
		local	value
	)

Sets a new key/value pair in the configuration dictionary.

Parameters

key	A given key.
value	A given value.

static Configuration* sharedConfiguration ( )

static

Deprecated:

Use getInstance() instead

local sharedConfiguration ( )

static

Deprecated:

Use getInstance() instead

bool supportsATITC

(

)

const

Whether or not ATITC Texture Compressed is supported.

Returns

Is true if supports ATITC Texture Compressed.

local supportsATITC

(

)

Whether or not ATITC Texture Compressed is supported.

Returns

Is true if supports ATITC Texture Compressed.

bool supportsBGRA8888

(

)

const

Whether or not BGRA8888 textures are supported.

Returns

Is true if supports BGRA8888 textures.

Since

v0.99.2

local supportsBGRA8888

(

)

Whether or not BGRA8888 textures are supported.

Returns

Is true if supports BGRA8888 textures.

Since

v0.99.2

bool supportsDiscardFramebuffer

(

)

const

Whether or not glDiscardFramebufferEXT is supported.

Returns

Is true if supports glDiscardFramebufferEXT.

Since

v0.99.2

local supportsDiscardFramebuffer

(

)

Whether or not glDiscardFramebufferEXT is supported.

Returns

Is true if supports glDiscardFramebufferEXT.

Since

v0.99.2

bool supportsETC

(

)

const

Whether or not ETC Texture Compressed is supported.

Returns

Is true if supports ETC Texture Compressed.

local supportsETC

(

)

Whether or not ETC Texture Compressed is supported.

Returns

Is true if supports ETC Texture Compressed.

bool supportsNPOT

(

)

const

Whether or not the GPU supports NPOT (Non Power Of Two) textures.

OpenGL ES 2.0 already supports NPOT (iOS).

Returns

Is true if supports NPOT.

Since

v0.99.2

local supportsNPOT

(

)

Whether or not the GPU supports NPOT (Non Power Of Two) textures.

OpenGL ES 2.0 already supports NPOT (iOS).

Returns

Is true if supports NPOT.

Since

v0.99.2

bool supportsPVRTC

(

)

const

Whether or not PVR Texture Compressed is supported.

Returns

Is true if supports PVR Texture Compressed.

local supportsPVRTC

(

)

Whether or not PVR Texture Compressed is supported.

Returns

Is true if supports PVR Texture Compressed.

bool supportsS3TC

(

)

const

Whether or not S3TC Texture Compressed is supported.

Returns

Is true if supports S3TC Texture Compressed.

local supportsS3TC

(

)

Whether or not S3TC Texture Compressed is supported.

Returns

Is true if supports S3TC Texture Compressed.

bool supportsShareableVAO

(

)

const

Whether or not shareable VAOs are supported.

Returns

Is true if supports shareable VAOs.

Since

v2.0.0

local supportsShareableVAO

(

)

Whether or not shareable VAOs are supported.

Returns

Is true if supports shareable VAOs.

Since

v2.0.0

Member Data Documentation

char* _glExtensions

protected

local _glExtensions

protected

int _maxDirLightInShader

protected

local _maxDirLightInShader

protected

GLint _maxModelviewStackDepth

protected

local _maxModelviewStackDepth

protected

int _maxPointLightInShader

protected

local _maxPointLightInShader

protected

GLint _maxSamplesAllowed

protected

local _maxSamplesAllowed

protected

int _maxSpotLightInShader

protected

local _maxSpotLightInShader

protected

GLint _maxTextureSize

protected

local _maxTextureSize

protected

GLint _maxTextureUnits

protected

local _maxTextureUnits

protected

bool _supportsATITC

protected

local _supportsATITC

protected

bool _supportsBGRA8888

protected

local _supportsBGRA8888

protected

bool _supportsDiscardFramebuffer

protected

local _supportsDiscardFramebuffer

protected

bool _supportsETC1

protected

local _supportsETC1

protected

bool _supportsNPOT

protected

local _supportsNPOT

protected

bool _supportsPVRTC

protected

local _supportsPVRTC

protected

bool _supportsS3TC

protected

local _supportsS3TC

protected

bool _supportsShareableVAO

protected

local _supportsShareableVAO

protected

ValueMap _valueDict

protected

local _valueDict

protected

---

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

• /Users/minggo/SourceCode/cocos2d-x/cocos/base/CCConfiguration.h