DzOpenGL Class Reference
[Manager Objects]

Provides management of OpenGL extensions and basic state. More...

Inheritance diagram for DzOpenGL:

List of all members.

Enumerations
enum	OGLTexQuality { OGLLow = 0, OGLMed = 1, OGLHigh = 2, OGLBest = 3 }
Methods
Number	getDepthBufferBits ()
Number	getMaxTextureSize ()
Number	getMaxTextureUnits ()
Number	getNumAuxBuffers ()
Number	getNumLights ()
Number	getNumOGLExtensions ()
Number	getOpenGLVersion ()
DzPBuffer	getPBuffer ()
OGLTexQuality	getTextureQuality ()
Number	getTextureQualityMaxSize ()
Boolean	isDisplayOptimizationEnabled ()
Boolean	isMultisampleEnabled ()
Boolean	isMultisampleSupported ()
Boolean	isOGLExtensionSupported (String extension)
Boolean	isOGLInitialized ()
Boolean	isOGLShaderLanguageSupported ()
Boolean	isShadowingSupported ()
Boolean	isVBOSupported ()
void	setDisplayOptimizationEnabled (Boolean onOff)
void	setMultisampleEnabled (Boolean onOff)
void	setTextureQuality (OGLTexQuality quality)
Signals
void	displayOptimizationEnabled (Boolean onOff)
	Signature: "displayOptimizationEnabled(bool)"
void	multisampleEnabled (Boolean onOff)
	Signature: "multisampleEnabled(bool)"
void	textureQualityChanged (OGLTexQuality quality)
	Signature: "textureQualityChanged(DzOpenGL::OGLTexQuality)"

---

Detailed Description

Provides management of OpenGL extensions and basic state.

You can access the global instance of DzOpenGL via the global variable OpenGL.

---

Member Enumeration Documentation

enum DzOpenGL::OGLTexQuality

Defines the possible values for the application-wide texture quality settings.

Enumerator:

OGLLow	Lowest quality / Best performance. Texture sizes are clamped to a small size or the maximum size supported by the hardware, whichever is less.
OGLMed	Medium quality / Better performance. Texture sizes are clamped to a medium size or the maximum size supported by the hardware, whichever is less.
OGLHigh	High quality / Good performance. Texture sizes are clamped to a large size or the maximum size supported by the hardware, whichever is less.
OGLBest	Best quality / Low performance. Texture sizes are clamped to the maximum size supported by the hardware.

---

Member Function Documentation

DzOpenGL::displayOptimizationEnabled

(

Boolean

onOff

)

[signal]

Signature: "displayOptimizationEnabled(bool)"

Emitted when display optimization is disabled or enabled.

Parameters:

onOff

If true, display optimization was enabled. If false, display optimization was disabled.

Number DzOpenGL::getDepthBufferBits

(

)

Returns:

The number of bit depth of the client depth buffer.

Number DzOpenGL::getMaxTextureSize

(

)

Returns:

The maximim texture size supported by the client.

Number DzOpenGL::getMaxTextureUnits

(

)

Returns:

The maximim number of textures supported by the client.

Number DzOpenGL::getNumAuxBuffers

(

)

Returns:

The number auxiliary buffers supported by the client.

Number DzOpenGL::getNumLights

(

)

Returns:

The maximim number of lights supported by the client.

Number DzOpenGL::getNumOGLExtensions

(

)

Returns:

The number of supported OpenGL extensions

Number DzOpenGL::getOpenGLVersion

(

)

Returns:

The OpenGL major and minor version numbers supported on the currently running hardware.

DzPBuffer DzOpenGL::getPBuffer

(

)

Returns:

A pointer to the application-wide global PBuffer object

OGLTextQuality DzOpenGL::getTextureQuality

(

)

Returns:

The current quality setting for loading OpenGL textures

Number DzOpenGL::getTextureQualityMaxSize

(

)

Returns:

The maximum dimension for a texture map based on the current OpenGL texture quality setting.

Boolean DzOpenGL::isDisplayOptimizationEnabled

(

)

Returns:

true if the user has enabled display optimization and if its supported.

Boolean DzOpenGL::isMultisampleEnabled

(

)

Returns:

true if the user has enabled hardware antialiasing.

Boolean DzOpenGL::isMultisampleSupported

(

)

Returns:

true if the client supports hardware antialiasing.

Boolean DzOpenGL::isOGLExtensionSupported

(

String

extension

)

Returns:

true if the given OpenGL extension is supported

bool DzOpenGL::isOGLInitialized

(

)

Returns:

true if the OpenGL, and the DAZ-supported OpenGL extensions have been initialized. The other OpenGL support funtions will not return the correct result until initialization has occured.

Boolean DzOpenGL::isOGLShaderLanguageSupported

(

)

Checks for support of the four following extensions: GL_ARB_shader_objects, GL_ARB_fragment_shader, GL_ARB_vertex_shader, GL_ARB_shading_language_100. All four extensions must exist for this function to return true.

Returns:

true if OpenGL Shader Language is supported

Boolean DzOpenGL::isShadowingSupported

(

)

Returns:

true if the client supports hardware shadow mapping.

Boolean DzOpenGL::isVBOSupported

(

)

Returns:

true if the client supports Vertex Buffer Objects.

DzOpenGL::multisampleEnabled

(

Boolean

onOff

)

[signal]

Signature: "multisampleEnabled(bool)"

Emitted when multisample is disabled or enabled.

Parameters:

onOff

If true, multipsample was enabled. If false, multisample was disabled.

void DzOpenGL::setDisplayOptimizationEnabled

(

Boolean

onOff

)

Sets whether or not display optimization is enabled in the OpenGL viewports

void DzOpenGL::setMultisampleEnabled

(

Boolean

onOff

)

Sets whether or not multisampling is enabled in the OpenGL viewports

void DzOpenGL::setTextureQuality

(

OGLTexQuality

quality

)

Sets the quality setting for loading OpenGL textures

DzOpenGL::textureQualityChanged

(

DzOpenGL::OGLTexQuality

_t1

)

[signal]

Signature: "textureQualityChanged(DzOpenGL::OGLTexQuality)"

Emitted when the texture quality setting has changed.

Parameters:

quality

The new texture quality setting.

---

Copyright © 2002 - 2009 DAZ 3D, Inc.