cocos2d-x  3.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Configuration Class Reference

Configuration contains some openGL variables. More...

#include <CCConfiguration.h>

Inheritance diagram for Configuration:
Ref

Public Member Functions

virtual ~Configuration ()
 NA NA More...
 
int getMaxTextureSize () const
 OpenGL Max texture size. More...
 
int getMaxModelviewStackDepth () const
 OpenGL Max Modelview Stack Depth. More...
 
int getMaxTextureUnits () const
 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...
 
bool supportsS3TC () const
 Whether or not S3TC Texture Compressed is supported. More...
 
bool supportsATITC () const
 Whether or not ATITC Texture Compressed is supported. More...
 
bool supportsBGRA8888 () const
 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 since v3.3. More...
 
int getMaxSupportSpotLightInShader () const
 Max support spot light in shader, for Sprite3D since v3.3. More...
 
bool checkForGLExtension (const std::string &searchName) const
 returns whether or not an OpenGL is supported More...
 
bool init ()
 
const ValuegetValue (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...
 
void loadConfigFile (const std::string &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...
 
Refautorelease ()
 Releases the ownership sometime soon automatically. More...
 
unsigned int getReferenceCount () const
 Returns the Ref's current reference count. More...
 
virtual ~Ref ()
 NA NA More...
 

Static Public Member Functions

static ConfigurationgetInstance ()
 returns a shared instance of Configuration More...
 
static void destroyInstance ()
 purge the shared instance of Configuration More...
 
static ConfigurationsharedConfiguration ()
 
static void purgeConfiguration ()
 

Protected Attributes

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

Additional Inherited Members

- Protected Member Functions inherited from Ref
 Ref ()
 Constructor. More...
 

Detailed Description

Configuration contains some openGL variables.

Since
v0.99.0

Constructor & Destructor Documentation

virtual ~Configuration ( )
virtual

NA NA

Member Function Documentation

bool checkForGLExtension ( const std::string &  searchName) const

returns whether or not an OpenGL is supported

static void destroyInstance ( )
static

purge the shared instance of Configuration

void gatherGPUInfo ( )

gathers OpenGL / GPU information

std::string getInfo ( ) const

returns the Configuration info

static Configuration* getInstance ( )
static

returns a shared instance of Configuration

int getMaxModelviewStackDepth ( ) const

OpenGL Max Modelview Stack Depth.

int getMaxSupportDirLightInShader ( ) const

Max support directional light in shader, for Sprite3D.

Since
v3.3
int getMaxSupportPointLightInShader ( ) const

Max support point light in shader, for Sprite3D since v3.3.

int getMaxSupportSpotLightInShader ( ) const

Max support spot light in shader, for Sprite3D since v3.3.

int getMaxTextureSize ( ) const

OpenGL Max texture size.

int getMaxTextureUnits ( ) const

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

bool init ( )
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.

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

sets a new key/value pair in the configuration dictionary

static Configuration* sharedConfiguration ( )
static
bool supportsATITC ( ) const

Whether or not ATITC Texture Compressed is supported.

bool supportsBGRA8888 ( ) const

Whether or not BGRA8888 textures are supported.

Since
v0.99.2
bool supportsDiscardFramebuffer ( ) const

Whether or not glDiscardFramebufferEXT is supported.

Since
v0.99.2
bool supportsETC ( ) const

Whether or not ETC Texture Compressed is supported.

bool supportsNPOT ( ) const

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

OpenGL ES 2.0 already supports NPOT (iOS).

Since
v0.99.2
bool supportsPVRTC ( ) const

Whether or not PVR Texture Compressed is supported.

bool supportsS3TC ( ) const

Whether or not S3TC Texture Compressed is supported.

bool supportsShareableVAO ( ) const

Whether or not shareable VAOs are supported.

Since
v2.0.0

Member Data Documentation

char* _glExtensions
protected
int _maxDirLightInShader
protected
GLint _maxModelviewStackDepth
protected
int _maxPointLightInShader
protected
GLint _maxSamplesAllowed
protected
int _maxSpotLightInShader
protected
GLint _maxTextureSize
protected
GLint _maxTextureUnits
protected
bool _supportsATITC
protected
bool _supportsBGRA8888
protected
bool _supportsDiscardFramebuffer
protected
bool _supportsETC1
protected
bool _supportsNPOT
protected
bool _supportsPVRTC
protected
bool _supportsS3TC
protected
bool _supportsShareableVAO
protected
ValueMap _valueDict
protected

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