Archon::Display::Visual Struct Reference

A visual is a specification of which pixel buffers are needed in a rendering target such as a window, and it specifies how big theese buffers needs to be in terms of bit-width per pixel. More...

#include <archon/display/visual.H>

Inheritance diagram for Archon::Display::Visual:

[legend]Collaboration diagram for Archon::Display::Visual:

[legend]List of all members.

Public Member Functions
virtual Ref< Screen >	getScreen ()=0
	Get the associated screen descriptor.
virtual Ref< Window >	newWindow (int left, int top, int width, int height, string title="")=0 throw (NoWindowsException)
	Create a new window with pixel buffers as described by this visual on the screen associated with this visual.
virtual Ref< Context >	newContext (bool direct=true, Ref< Context > shareWith=0)=0 throw (invalid_argument)
	Create a new OpenGL rendering context.
virtual int	getRedBufferSize ()=0
	Get the number of bits per pixel in the red color buffer of this visual.
virtual int	getGreenBufferSize ()=0
	Get the number of bits per pixel in the green color buffer of this visual.
virtual int	getBlueBufferSize ()=0
	Get the number of bits per pixel in the blue color buffer of this visual.
virtual int	getAlphaBufferSize ()=0
	Get the number of bits per pixel in the alpha color buffer of this visual.
virtual int	getDepthBufferSize ()=0
	Get the number of bits per pixel in the depth buffer of this visual.
virtual int	getStencilBufferSize ()=0
	Get the number of bits per pixel in the stencil buffer of this visual.
virtual int	getAccumRedBufferSize ()=0
	Get the number of bits per pixel in the red accumulation buffer of this visual.
virtual int	getAccumGreenBufferSize ()=0
	Get the number of bits per pixel in the green accumulation buffer of this visual.
virtual int	getAccumBlueBufferSize ()=0
	Get the number of bits per pixel in the blue accumulation buffer of this visual.
virtual int	getAccumAlphaBufferSize ()=0
	Get the number of bits per pixel in the alpha accumulation buffer of this visual.

---

Detailed Description

A visual is a specification of which pixel buffers are needed in a rendering target such as a window, and it specifies how big theese buffers needs to be in terms of bit-width per pixel.

Each screen offers one or more distinct visual.

On the X Window System this is a wrapper around the XVisualInfo structure of Xlib.

Visual descriptors are obtained by various methods in the Screen class.

See also:

Screen

http://www.x.org

Definition at line 75 of file visual.H.

---

Member Function Documentation

virtual int Archon::Display::Visual::getAccumAlphaBufferSize (   )  [pure virtual]

Get the number of bits per pixel in the alpha accumulation buffer of this visual. Returns: The bit-width of the alpha accumulation buffer. Implemented in Archon::Display::VisualX11.

virtual int Archon::Display::Visual::getAccumBlueBufferSize (   )  [pure virtual]

Get the number of bits per pixel in the blue accumulation buffer of this visual. Returns: The bit-width of the blue accumulation buffer. Implemented in Archon::Display::VisualX11.

virtual int Archon::Display::Visual::getAccumGreenBufferSize (   )  [pure virtual]

Get the number of bits per pixel in the green accumulation buffer of this visual. Returns: The bit-width of the green accumulation buffer. Implemented in Archon::Display::VisualX11.

virtual int Archon::Display::Visual::getAccumRedBufferSize (   )  [pure virtual]

Get the number of bits per pixel in the red accumulation buffer of this visual. Returns: The bit-width of the red accumulation buffer. Implemented in Archon::Display::VisualX11.

virtual int Archon::Display::Visual::getAlphaBufferSize (   )  [pure virtual]

Get the number of bits per pixel in the alpha color buffer of this visual. Returns: The bit-width of the alpha color buffer. Implemented in Archon::Display::VisualX11.

virtual int Archon::Display::Visual::getBlueBufferSize (   )  [pure virtual]

Get the number of bits per pixel in the blue color buffer of this visual. Returns: The bit-width of the blue color buffer. Implemented in Archon::Display::VisualX11.

virtual int Archon::Display::Visual::getDepthBufferSize (   )  [pure virtual]

Get the number of bits per pixel in the depth buffer of this visual. Returns: The bit-width of the depth buffer. Implemented in Archon::Display::VisualX11.

virtual int Archon::Display::Visual::getGreenBufferSize (   )  [pure virtual]

Get the number of bits per pixel in the green color buffer of this visual. Returns: The bit-width of the green color buffer. Implemented in Archon::Display::VisualX11.

virtual int Archon::Display::Visual::getRedBufferSize (   )  [pure virtual]

Get the number of bits per pixel in the red color buffer of this visual. Returns: The bit-width of the red color buffer. Implemented in Archon::Display::VisualX11.

virtual Ref<Screen> Archon::Display::Visual::getScreen (   )  [pure virtual]

Get the associated screen descriptor. Returns: A descriptor for the screen to which this visual belongs. Implemented in Archon::Display::VisualX11.

virtual int Archon::Display::Visual::getStencilBufferSize (   )  [pure virtual]

Get the number of bits per pixel in the stencil buffer of this visual. Returns: The bit-width of the stencil buffer. Implemented in Archon::Display::VisualX11.

virtual Ref<Context> Archon::Display::Visual::newContext (  bool  direct = true, Ref< Context >  shareWith = 0 )  throw (invalid_argument) [pure virtual]

Create a new OpenGL rendering context. On the X Window System this is a wrapper around the glXCreateContext call. Parameters: direct  If true a direct rendering context will be used if available. Direct rendering contexts offers better performance but generally works only on a display of the local host. After the Context is created you may call isDirect() to determine if a direct rendering context was in fact aquired. shareWith  Another context with which display lists and texture objects should be shared. Exceptions: invalid_argument  If the context argument belongs to a different implementation that this context. See also: Context http://www.x.org Implemented in Archon::Display::VisualX11.

virtual Ref<Window> Archon::Display::Visual::newWindow (  int  left, int  top, int  width, int  height, string  title = "" )  throw (NoWindowsException) [pure virtual]

Create a new window with pixel buffers as described by this visual on the screen associated with this visual. Parameters: left  Initial horizontal displacement of the left outside edge of the window measured from the left edge of the screen. Increasing this value moves the window further to the right. top  Initial vertical displacement of upper outside edge of the window measured from the top edge of the screen. Increasing this value moves the window further down. width  Initial width in pixels of the windows contents area. height  Initial height in pixels of the windows contents area. title  Initial title to display in the title bar of this window. Exceptions: NoWindowsException  If windows are not supported by the implementation in use. See also: Window Implemented in Archon::Display::VisualX11.

---

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

• archon/display/visual.H

---