DzPBuffer Class Reference
[Object and Geometry Objects]

Class that encapsulates an OpenGL P-Buffer rendering context. More...

List of all members.

Methods

Number getHeight ()
Number getMaxSize ()
Number getWidth ()
Boolean isEnabled ()
Boolean isSupported ()
Boolean isValid ()
void setEnabled (Boolean onOff)
void setMaxSize (Number maxSize)


Detailed Description

Class that encapsulates an OpenGL P-Buffer rendering context.

Do not create an instance of this class yourself, rather, request a pointer to the global pbuffer object via DzOpenGL::getPBuffer().


Member Function Documentation

Number DzPBuffer::getHeight (  ) 

Returns:
The height of the pbuffer (0 if it is not valid)

Number DzPBuffer::getMaxSize (  ) 

Returns:
The maximum size for the pbuffer (the pbuffer is created square: i.e. maxSize x maxSize)

Number DzPBuffer::getWidth (  ) 

Returns:
The width of the pbuffer (0 if it is not valid)

Boolean DzPBuffer::isEnabled (  ) 

Returns:
true if the global pixel buffer is enabled.

Boolean DzPBuffer::isSupported (  ) 

Returns:
true if the current hardware supports pixel buffers.

Boolean DzPBuffer::isValid (  ) 

Returns:
true if this pbuffer is a valid OpenGL context.

void DzPBuffer::setEnabled ( Boolean  onOff  ) 

Sets whether pbuffer rendering is enabled. If it is enabled and the hardware supports pbuffers, the largest available pbuffer will be allocated on the hardware. If it is disabled, no pbuffer object is allocated, and the pbuffer object will return false for isValid().

void DzPBuffer::setMaxSize ( Number  maxSize  ) 

Sets the maximum size for the pbuffer (the pbuffer is created square: i.e. maxSize x maxSize)

Parameters:
maxSize The new maximum PBuffer size. Sizes of 512, 1024, and 2048 are currently supported. Other values will be rounded to the nearest supported size.


Generated on Thu Sep 24 12:21:14 2009

Copyright © 2002 - 2009 DAZ 3D, Inc.