Cocos2d-x  v3.17
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
Configuration Class Reference

Configuration contains some openGL variables. More...

Inherits Ref.

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...
 
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...
 
bool supportsOESDepth24 () const
 Whether or not OES_depth24 is supported. More...
 
local supportsOESDepth24 ()
 Whether or not OES_depth24 is supported. More...
 
bool supportsOESPackedDepthStencil () const
 Whether or not OES_Packed_depth_stencil is supported. More...
 
bool supportsMapBuffer () const
 Whether or not glMapBuffer() is 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...
 
Animate3DQuality getAnimate3DQuality () const
 get 3d animate quality
 
local getAnimate3DQuality ()
 get 3d animate quality
 
bool checkForGLExtension (const std::string &searchName) const
 Returns whether or not an OpenGL is supported. More...
 
local checkForGLExtension ( local searchName)
 Returns whether or not an OpenGL is supported. More...
 
bool init ()
 Initialize method. More...
 
local 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.
 
local gatherGPUInfo ()
 Gathers OpenGL / GPU information.
 
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...
 
local release ()
 Releases the ownership immediately. More...
 
Refautorelease ()
 Releases the ownership sometime soon automatically. More...
 
unsigned int getReferenceCount () const
 Returns the Ref's current reference count. More...
 
local getReferenceCount ()
 Returns the Ref's current reference count. More...
 
virtual ~Ref ()
 Destructor. More...
 

Static Public Member Functions

static ConfigurationgetInstance ()
 Returns a shared instance of Configuration. More...
 
static void destroyInstance ()
 Purge the shared instance of Configuration.
 
local destroyInstance ()
 Purge the shared instance of Configuration.
 
static ConfigurationsharedConfiguration ()
local sharedConfiguration ()
static void purgeConfiguration ()
local purgeConfiguration ()

Additional Inherited Members

- Public Attributes inherited from Ref
unsigned int _ID
 object id, ScriptSupport need public _ID
 
local _ID
 object id, ScriptSupport need public _ID
 
int _luaID
 Lua reference id.
 
local _luaID
 Lua reference id.
 
void * _scriptObject
 scriptObject, support for swift
 
local _scriptObject
 scriptObject, support for swift
 
bool _rooted
 When true, it means that the object was already rooted.
 
local _rooted
 When true, it means that the object was already rooted.
 

Detailed Description

Configuration contains some openGL variables.

Since
v0.99.0

Constructor & Destructor Documentation

virtual ~Configuration ( )
virtual

Destructor.

Member Function Documentation

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.
static Configuration*
sharedConfiguration
( )
static
local sharedConfiguration ( )
static
static void purgeConfiguration ( )
static
local purgeConfiguration ( )
static
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 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 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
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 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 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 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 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
bool supportsOESDepth24 ( ) const

Whether or not OES_depth24 is supported.

Returns
Is true if supports OES_depth24.
Since
v2.0.0
local supportsOESDepth24 ( )

Whether or not OES_depth24 is supported.

Returns
Is true if supports OES_depth24.
Since
v2.0.0
bool supportsOESPackedDepthStencil ( ) const

Whether or not OES_Packed_depth_stencil is supported.

Returns
Is true if supports OES_Packed_depth_stencil.
Since
v2.0.0
local supportsOESPackedDepthStencil ( )

Whether or not OES_Packed_depth_stencil is supported.

Returns
Is true if supports OES_Packed_depth_stencil.
Since
v2.0.0
bool supportsMapBuffer ( ) const

Whether or not glMapBuffer() is supported.

On Desktop it returns true. On Mobile it checks for the extension GL_OES_mapbuffer

Returns
Whether or not glMapBuffer() is supported.
Since
v3.13
local supportsMapBuffer ( )

Whether or not glMapBuffer() is supported.

On Desktop it returns true. On Mobile it checks for the extension GL_OES_mapbuffer

Returns
Whether or not glMapBuffer() is supported.
Since
v3.13
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
bool checkForGLExtension ( const std::string &  searchName) const

Returns whether or not an OpenGL is supported.

Parameters
searchNameA given search name.
Returns
Is true if an OpenGL is supported.
local checkForGLExtension ( local  searchName)

Returns whether or not an OpenGL is supported.

Parameters
searchNameA given search name.
Returns
Is true if an OpenGL is supported.
bool init ( )

Initialize method.

Returns
Is true if initialize success.
local init ( )

Initialize method.

Returns
Is true if initialize success.
const Value& getValue ( const std::string &  key,
const Value &  defaultValue = Value::Null 
) const

Returns the value of a given key as a double.

Parameters
keyA given key.
defaultValueif 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
keyA given key.
defaultValueif not find the value, return the defaultValue.
Returns
void setValue ( const std::string &  key,
const Value &  value 
)

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

Parameters
keyA given key.
valueA given value.
local setValue ( local  key,
local  value 
)

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

Parameters
keyA given key.
valueA given value.
std::string getInfo ( ) const

Returns the Configuration info.

Returns
The Configuration info.
local getInfo ( )

Returns the Configuration info.

Returns
The Configuration info.
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
filenameConfig 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
filenameConfig file name.

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