All Packages  This Package  Class Hierarchy  Class Search  Index

Class com.hermetica.magician.GLCapabilities
java.lang.Object
   |
   +----com.hermetica.magician.GLCapabilities

  Summary

public class  GLCapabilities
     extends java.lang.Object
     implements java.lang.Cloneable
{
          // Fields 12
     public static final int COLOUR_INDEX;
     public static final int DOUBLEBUFFER;
     public static final int DRAW_TO_BITMAP;
     public static final int DRAW_TO_WINDOW;
     public static final int MAIN_PLANE;
     public static final int OVERLAY_PLANE;
     public static final int RGBA;
     public static final int SINGLEBUFFER;
     public static final int STEREO;
     public static final int STEREO_DONTCARE;
     public static final int UNDERLAY_PLANE;
     public static final String VERSION;

          // Constructors 1
     public GLCapabilities();

          // Methods 47
     public final int getAccumAlphaBits();
     public final int getAccumBits();
     public final int getAccumBlueBits();
     public final int getAccumGreenBits();
     public final int getAccumRedBits();
     public final int getAlphaBits();
     public final int getAlphaShift();
     public final int getAuxiliaryBuffers();
     public final int getBlueBits();
     public final int getBlueShift();
     public final int getColourBits();
     public final int getDepthBits();
     public final int getDevice();
     public final boolean getDirectRendering();
     public final int getDoubleBuffered();
     public final int getGreenBits();
     public final int getGreenShift();
     public final int getLayerType();
     public final int getPixelType();
     public final int getRedBits();
     public final int getRedShift();
     public final int getStencilBits();
     public final int getStereo();
     public final boolean isLocked();
     public final void setAccumAlphaBits(int);
     public final void setAccumBits(int);
     public final void setAccumBlueBits(int);
     public final void setAccumGreenBits(int);
     public final void setAccumRedBits(int);
     public final void setAlphaBits(int);
     public final void setAlphaShift(int);
     public final void setAuxiliaryBuffers(int);
     public final void setBlueBits(int);
     public final void setBlueShift(int);
     public final void setColourBits(int);
     public final void setDepthBits(int);
     public final void setDevice(int);
     public final void setDirectRendering(boolean);
     public final void setDoubleBuffered(int);
     public final void setGreenBits(int);
     public final void setGreenShift(int);
     public final void setLayerType(int);
     public final void setPixelType(int);
     public final void setRedBits(int);
     public final void setRedShift(int);
     public final void setStencilBits(int);
     public final void setStereo(int);
}

The GLCapabilities class encapsulates the required format for a window that we wish to render onto, beit an X Visual, or a Win32 PIXELFORMATDESCRIPTOR. By using the GLCapabilities class, we can portably configure the settings for the required visual, which will then be tested to see if it is valid for the GLContext class it is attached to. The methods provided in this class need not all be used. Some methods may have no meaning under different types of window system, some are essentially X-specific, some Win32-specific. These will be ignored as required.

Version:
$Id: GLCapabilities.java,v 1.6 1998/05/14 12:42:53 descarte Exp descarte $
Author:
Alligator Descartes <descarte@arcana.co.uk>

See Also: GLContext


  Cross Reference

Returned By:
GLContext.getCapabilities()





  Fields

· VERSION

Summary  |  Top
   public static final String VERSION

Version information


· RGBA

Summary  |  Top
   public static final int RGBA

RGBA colour.

See Also: setPixelType, getPixelType


· COLOUR_INDEX

Summary  |  Top
   public static final int COLOUR_INDEX

Colour-index colour

See Also: setPixelType, getPixelType


· DOUBLEBUFFER

Summary  |  Top
   public static final int DOUBLEBUFFER

Specify we want double-buffering

See Also: setDoubleBuffered, getDoubleBuffered, SINGLEBUFFER


· SINGLEBUFFER

Summary  |  Top
   public static final int SINGLEBUFFER

Specify that we don't want double-buffering

See Also: setDoubleBuffered, getDoubleBuffered, DOUBLEBUFFER


· STEREO

Summary  |  Top
   public static final int STEREO

Specify that we want stereo rendering

See Also: setStereo, getStereo, STEREO_DONTCARE


· STEREO_DONTCARE

Summary  |  Top
   public static final int STEREO_DONTCARE

Specify that we don't care whether or not the target component context supports stereo rendering or not.

See Also: setStereo, getStereo, STEREO


· DRAW_TO_WINDOW

Summary  |  Top
   public static final int DRAW_TO_WINDOW

Specify that we want to render to a window

See Also: setDevice, getDevice, DRAW_TO_BITMAP


· DRAW_TO_BITMAP

Summary  |  Top
   public static final int DRAW_TO_BITMAP

Specify that we want to render to a window

See Also: setDevice, getDevice, DRAW_TO_WINDOW


· MAIN_PLANE

Summary  |  Top
   public static final int MAIN_PLANE

Specifies the main rendering plane


· OVERLAY_PLANE

Summary  |  Top
   public static final int OVERLAY_PLANE

Specifies that an overlay plane should be used


· UNDERLAY_PLANE

Summary  |  Top
   public static final int UNDERLAY_PLANE

Specifies that an underlay plane should be used


  Constructors

· GLCapabilities

Summary  |  Top

   public GLCapabilities() 

Default constructor



  Methods

· setPixelType

Summary  |  Top
   public final void setPixelType(int flags) 

Specifies the pixel colour type for the component

See Also: setPixelType, COLOUR_INDEX



· getPixelType

Summary  |  Top
   public final int getPixelType() 

Returns the pixel type of the context

See Also: getPixelType, RGBA



· setDoubleBuffered

Summary  |  Top
   public final void setDoubleBuffered(int flags) 

Specifies whether or not we want double-buffering

See Also: getDoubleBuffered, DOUBLEBUFFER, DOUBLEBUFFER_DONTCARE



· getDoubleBuffered

Summary  |  Top
   public final int getDoubleBuffered() 

Returns the current value of double-buffering in the component

See Also: DOUBLEBUFFER, DOUBLEBUFFER_DONTCARE, getDoubleBuffered



· setStereo

Summary  |  Top
   public final void setStereo(int flags) 

Specifies the stereo rendering capabilities of the component

See Also: STEREO, STEREO_DONTCARE, getStereo



· getStereo

Summary  |  Top
   public final int getStereo() 

Returns the current stereo rendering capabilities of the component

See Also: STEREO, STEREO_DONTCARE, setStereo



· setDevice

Summary  |  Top
   public final void setDevice(int flags) 

Specifies to which device type we should render to

See Also: DRAW_TO_WINDOW, DRAW_TO_BITMAP, getDevice



· getDevice

Summary  |  Top
   public final int getDevice() 

Returns the device type that we have created a component with

See Also: DRAW_TO_WINDOW, DRAW_TO_BITMAP, setDevice



· setColourBits

Summary  |  Top
   public final void setColourBits(int numBits) 

Sets the number of desired colour bit planes

See Also: getColourBits



· getColourBits

Summary  |  Top
   public final int getColourBits() 

Returns the number of colour bit planes

See Also: setColourBits



· setRedBits

Summary  |  Top
   public final void setRedBits(int numBits) 

Sets the number of red bit planes in each RGBA buffer

See Also: getRedBits



· getRedBits

Summary  |  Top
   public final int getRedBits() 

Returns the number of red bit planes in each RGBA buffer

See Also: setRedBits



· setGreenBits

Summary  |  Top
   public final void setGreenBits(int numBits) 

Sets the number of green bit planes in each RGBA buffer

See Also: getGreenBits



· getGreenBits

Summary  |  Top
   public final int getGreenBits() 

Returns the number of green bit planes in each RGBA buffer

See Also: setGreenBits



· setBlueBits

Summary  |  Top
   public final void setBlueBits(int numBits) 

Sets the number of blue bit planes in each RGBA buffer

See Also: getBlueBits



· getBlueBits

Summary  |  Top
   public final int getBlueBits() 

Returns the number of blue bit planes in each RGBA buffer

See Also: setBlueBits



· setAlphaBits

Summary  |  Top
   public final void setAlphaBits(int numBits) 

Sets the number of alpha bit planes in each RGBA buffer

See Also: getAlphaBits



· getAlphaBits

Summary  |  Top
   public final int getAlphaBits() 

Returns the number of red bit planes in each RGBA buffer

See Also: setRedBits



· setRedShift

Summary  |  Top
   public final void setRedShift(int shift) 

Sets the shift count for red bit planes in each RGBA buffer. This specifies where the red bits can be found in the colour buffer, for example, in an 8-bit, 256-colour visual, the last two bits in an 8-bit colour value are usually the two used for blue bit planes, therefore, the shift value will be 6.

See Also: getRedShift



· getRedShift

Summary  |  Top
   public final int getRedShift() 

Returns the red shift value

See Also: setRedShift



· setGreenShift

Summary  |  Top
   public final void setGreenShift(int shift) 

Sets the shift count for green bit planes in each RGBA buffer. This specifies where the green bits can be found in the colour buffer, for example, in an 8-bit, 256-colour visual, the last two bits in an 8-bit colour value are usually the two used for blue bit planes, therefore, the shift value will be 6.

See Also: getGreenShift



· getGreenShift

Summary  |  Top
   public final int getGreenShift() 

Returns the green shift value

See Also: setGreenShift



· setBlueShift

Summary  |  Top
   public final void setBlueShift(int shift) 

Sets the shift count for blue bit planes in each RGBA buffer. This specifies where the blue bits can be found in the colour buffer, for example, in an 8-bit, 256-colour visual, the last two bits in an 8-bit colour value are usually the two used for blue bit planes, therefore, the shift value will be 6.

See Also: getBlueShift



· getBlueShift

Summary  |  Top
   public final int getBlueShift() 

Returns the blue shift value

See Also: setBlueShift



· setAlphaShift

Summary  |  Top
   public final void setAlphaShift(int shift) 

Sets the shift count for alpha bit planes in each RGBA buffer. This specifies where the alpha bits can be found in the colour buffer, for example, in an 8-bit, 256-colour visual, the last two bits in an 8-bit colour value are usually the two used for blue bit planes, therefore, the shift value will be 6.

See Also: getAlphaShift



· getAlphaShift

Summary  |  Top
   public final int getAlphaShift() 

Returns the alpha shift value

See Also: setAlphaShift



· setAccumBits

Summary  |  Top
   public final void setAccumBits(int numBits) 

Specifies the number of bits in the accumulation buffer

See Also: getAccumBits



· getAccumBits

Summary  |  Top
   public final int getAccumBits() 

Returns the number of bits in the accumulation buffer

See Also: setAccumBits



· setAccumRedBits

Summary  |  Top
   public final void setAccumRedBits(int numBits) 

Specifies the number of red bit planes in the accumulation buffer

See Also: getAccumRedBits



· getAccumRedBits

Summary  |  Top
   public final int getAccumRedBits() 

Returns the number of red bit planes in the accumulation buffer

See Also: setAccumRedBits



· setAccumGreenBits

Summary  |  Top
   public final void setAccumGreenBits(int numBits) 

Specifies the number of green bit planes in the accumulation buffer

See Also: getAccumGreenBits



· getAccumGreenBits

Summary  |  Top
   public final int getAccumGreenBits() 

Returns the number of green bit planes in the accumulation buffer

See Also: setAccumGreenBits



· setAccumBlueBits

Summary  |  Top
   public final void setAccumBlueBits(int numBits) 

Specifies the number of blue bit planes in the accumulation buffer

See Also: getAccumBlueBits



· getAccumBlueBits

Summary  |  Top
   public final int getAccumBlueBits() 

Returns the number of blue bit planes in the accumulation buffer

See Also: setAccumBlueBits



· setAccumAlphaBits

Summary  |  Top
   public final void setAccumAlphaBits(int numBits) 

Specifies the number of alpha bit planes in the accumulation buffer

See Also: getAccumAlphaBits



· getAccumAlphaBits

Summary  |  Top
   public final int getAccumAlphaBits() 

Returns the number of alpha bit planes in the accumulation buffer

See Also: setAccumAlphaBits



· setStencilBits

Summary  |  Top
   public final void setStencilBits(int numBits) 

Specifies the number of stencil bit planes in the stencil buffer

See Also: getStencilBits



· getStencilBits

Summary  |  Top
   public final int getStencilBits() 

Returns the number of bits in the stencil buffer

See Also: setStencilBits



· setDepthBits

Summary  |  Top
   public final void setDepthBits(int numBits) 

Sets the number of bits in the depth buffer

See Also: getDepthBits



· getDepthBits

Summary  |  Top
   public final int getDepthBits() 

Returns the number of bits in the depth buffer

See Also: setDepthBits



· setAuxiliaryBuffers

Summary  |  Top
   public final void setAuxiliaryBuffers(int numBuffers) 

Sets the number of auxiliary buffers

See Also: getAuxiliaryBuffers



· getAuxiliaryBuffers

Summary  |  Top
   public final int getAuxiliaryBuffers() 

Returns the number of auxiliary buffers

See Also: setAuxiliaryBuffers



· setLayerType

Summary  |  Top
   public final void setLayerType(int layerType) 

Sets the type of rendering layer this visual should use

See Also: getLayerType, MAIN_PLANE, OVERLAY_PLANE, UNDERLAY_PLANE



· getLayerType

Summary  |  Top
   public final int getLayerType() 

Returns the type of rendering layer used by this visual

See Also: setLayerType, MAIN_PLANE, OVERLAY_PLANE, UNDERLAY_PLANE



· isLocked

Summary  |  Top
   public final boolean isLocked() 

Returns whether or not this capability object is locked, ie, the context associated with it has been created successfully.

See Also: GLContext



· setDirectRendering

Summary  |  Top
   public final void setDirectRendering(boolean isDirect) 

Sets whether or not a direct rendering context should be used

Parameter Description
isDirect Specifies whether or not a direct rendering context should be used



· getDirectRendering

Summary  |  Top
   public final boolean getDirectRendering() 

Returns whether or not a direct rendering context is being used



All Packages  This Package  Class Hierarchy  Class Search  Index
Freshly brewed Java API Documentation automatically generated with polardoc Version 1.0.7