User Tools

Site Tools


DzOpenGL

Provides management of OpenGL extensions and basic state.

More...

Inherits :

Enumerations

Constructors

DAZ Script
BooleanisOGLInitialized ()

Methods

Signals

Detailed Description

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

Enumerations


: OGLTexQuality

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

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

Constructors


Boolean : isOGLInitialized()

Return Value:

  • 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 occurred.

Methods


Number : getBoundingBoxActiveOpacity()

Return Value:

  • the opacity value of the bounding box for active ( highlighted ) nodes.

Number : getBoundingBoxEdgeLength()

Return Value:

  • the length of the edges of the bounding boxes.

Number : getBoundingBoxInactiveOpacity()

Return Value:

  • the opacity value of the bounding box for inactive nodes that are selected.

Number : getDepthBufferBits()

Return Value:

  • The number of bit depth of the client depth buffer.

Boolean : getDrawNodeHighlight()

Return Value:

  • true if nodes should be drawn with a highlight

Number : getMajorVersion()

Return Value:

  • The major version number of OpenGL supported on the current hardware.

Number : getMaxTextureSize()

Return Value:

  • The maximim texture size supported by the client.

Number : getMaxTextureUnits()

Return Value:

  • The maximim number of textures supported by the client.

Number : getMinorVersion()

Return Value:

  • The minor version number of OpenGL supported on the current hardware.

Number : getNumAuxBuffers()

Return Value:

  • The number auxiliary buffers supported by the client.

Number : getNumLights()

Return Value:

  • The maximim number of lights supported by the client.

Number : getNumOGLExtensions()

Return Value:

  • The number of supported OpenGL extensions

Number : getOpenGLVersion()

Return Value:

  • The OpenGL major and minor version numbers supported on the current hardware.

pbuffer_dz : getPBuffer()

Return Value:

  • A pointer to the application-wide global PBuffer object

Number : getReleaseNumber()

Return Value:

  • The release number of OpenGL supported on the current hardware.

Number : getSubDivisionWireOpacity()

Return Value:

  • the opacity value of the wireframe for the generated edges of a subdivided mesh.

OGLTexQuality : getTextureQuality()

Return Value:

  • The current quality setting for loading OpenGL textures

Number : getTextureQualityMaxSize()

Return Value:

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

Number : getTriDivisionWireOpacity()

Return Value:

  • the opacity value of the wireframe for drawn triangulation of quads.

Since:

  • 4.9.3.142

Number : getWireframeOpacity()

Return Value:

  • the opacity value of the wireframe for the edges of a mesh.

Boolean : isDisplayOptimizationEnabled()

Return Value:

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

Boolean : isMultisampleEnabled()

Return Value:

  • true if the user has enabled hardware antialiasing.

Boolean : isMultisampleSupported()

Return Value:

  • true if the client supports hardware antialiasing.

Boolean : isOGLExtensionSupported( String extension )

Parameter(s):

  • extension - The extension to check

Return Value:

  • true if the given OpenGL extension is supported

Boolean : 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.

Return Value:

  • true if OpenGL Shader Language is supported

Boolean : isShadowingSupported()

Return Value:

  • true if the client supports hardware shadow mapping.

Boolean : isVBOSupported()

Return Value:

  • true if the client supports Vertex Buffer Objects.

void : setBoundingBoxActiveOpacity( Number opacity )

Sets the opacity of the bounding box for active ( highlighted ) nodes.

Parameter(s):

  • opacity - The opacity value to be used

void : setBoundingBoxEdgeLength( Number length )

Sets the length of the edges of the bounding boxes.

Parameter(s):

  • length - The edge length to be used

void : setBoundingBoxInactiveOpacity( Number opacity )

Sets the opacity of the bounding box for inactive nodes that are selected.

Parameter(s):

  • opacity - The opacity value to be used

void : setDisplayOptimizationEnabled( Boolean onOff )

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

Parameter(s):

  • onOff - If true, display optimizations will be enabled

Deprecated

use setPrimitiveDrawMode instead


void : setDrawNodeHighlight( Boolean onOff )

Parameter(s):

  • onOff - If true, nodes will be drawn with a highlight

void : setMultisampleEnabled( Boolean onOff )

Sets whether or not multisampling is enabled in the OpenGL viewports

Parameter(s):

  • onOff - if true, multisampling is enabled

void : setSubDivisionWireOpacity( Number opacity )

Sets the opacity of the wireframe for the generated edges of a subdivided mesh.

Parameter(s):

  • opacity - The opacity value

void : setTextureQuality( OGLTexQuality quality )

Sets the quality setting for loading OpenGL textures

Parameter(s):

  • quality - The quality of the texture

void : setTriDivisionWireOpacity( Number opacity )

Sets the opacity of the wireframe for the generated edges of a subdivided mesh.

Parameter(s):

  • opacity - The opacity value

Since:

  • 4.9.3.142

void : setWireframeOpacity( Number opacity )

Sets the opacity of the wireframe for the edges of a mesh.

Parameter(s):

  • opacity - The opacity value

Signals


void : boundingBoxActiveOpacityChanged( Number value )

TODO: Add description.


void : boundingBoxEdgeLengthChanged( Number value )

TODO: Add description.


void : boundingBoxInactiveOpacityChanged( Number value )

TODO: Add description.


void : displayOptimizationEnabled( Boolean onOff )

Signature:“displayOptimizationEnabled(bool)”

Emitted when display optimization is disabled or enabled.

Parameter(s):

  • onOff - If true, display optimization was enabled. If false, display optimization was disabled.

void : multisampleEnabled( Boolean onOff )

Signature:“multisampleEnabled(bool)”

Emitted when multisample is disabled or enabled.

Parameter(s):

  • onOff - If true, multipsample was enabled. If false, multisample was disabled.

void : subDivisionWireOpacityChanged( Number value )

TODO: Add description.


void : subWireframeOpacityChanged( Number value )

TODO: Add description.


void : textureQualityChanged( OGLTexQuality quality )

Signature:“textureQualityChanged(DzOpenGL::OGLTexQuality)”

Emitted when the texture quality setting has changed.

Parameter(s):

  • quality - The new texture quality setting.