G3D::OSWindow::Settings Class Reference

Public Member Functions
	Settings ()
class ImageFormat *	colorFormat () const
	Computes the image format closest to these settings for the color buffer.

Public Attributes
bool	allowMaximize
	If a window's settings define it to be both resizable and allowed to maximize, it will have an activated maximize button (for Win32 windows only)
int	alphaBits
bool	asynchronous
	Should buffer flips be un-hitched from refresh rate? true, false.
std::string	caption
	Window title.
bool	center
	If true, overrides the x and y settings.
std::string	defaultIconFilename
	Default icon that the OSWindow implementation tries to set initially.
int	depthBits
	0 (autodetect the best for this card), 16, 24, 32
bool	framed
	When true, a window frame and title bar are present.
bool	fullScreen
	Applications that fill the screen may also want to set framed = false.
bool	hardware
	Will you accept a software rendering pipeline? Used to determine if a hardware only pixel format is required.
int	height
int	msaaSamples
	Number of samples per pixel for anti-aliasing purposes.
int	refreshRate
	Refresh rate for full-screen, in cycles/sec.
bool	resizable
	If true, you should set up your event loop as described in the docs for RenderDevice::resize.
int	rgbBits
	The number of bits in each color channel of the frame buffer.
bool	sharedContext
	If true, Texture and AttributeArray data will be shared between multiple OpenGL contexts.
int	stencilBits
	8
bool	stereo
	Allocate a stereo display context.
bool	visible
	When true, the window begins visible.
int	width
	Width of the client area in pixels.
int	x
	Initial x position of the client area in screen space (can be overridden by fullScreen and center)
int	y
	Initial y position of the client area in screen space (can be overridden by fullScreen and center)

Constructor & Destructor Documentation

G3D::OSWindow::Settings::Settings

(

)

Member Function Documentation

class ImageFormat* G3D::OSWindow::Settings::colorFormat

(

)

const

Computes the image format closest to these settings for the color buffer.

Member Data Documentation

bool G3D::OSWindow::Settings::allowMaximize

If a window's settings define it to be both resizable and allowed to maximize, it will have an activated maximize button (for Win32 windows only)

int G3D::OSWindow::Settings::alphaBits

bool G3D::OSWindow::Settings::asynchronous

Should buffer flips be un-hitched from refresh rate? true, false.

True generally gives higher frame rates.

std::string G3D::OSWindow::Settings::caption

Window title.

bool G3D::OSWindow::Settings::center

If true, overrides the x and y settings.

std::string G3D::OSWindow::Settings::defaultIconFilename

Default icon that the OSWindow implementation tries to set initially.

defaults to System::findDataFile("G3D-64.png", false).

int G3D::OSWindow::Settings::depthBits

0 (autodetect the best for this card), 16, 24, 32

bool G3D::OSWindow::Settings::framed

When true, a window frame and title bar are present.

bool G3D::OSWindow::Settings::fullScreen

Applications that fill the screen may also want to set framed = false.

bool G3D::OSWindow::Settings::hardware

Will you accept a software rendering pipeline? Used to determine if a hardware only pixel format is required.

int G3D::OSWindow::Settings::height

int G3D::OSWindow::Settings::msaaSamples

Number of samples per pixel for anti-aliasing purposes.

1 (none), 4, 8

int G3D::OSWindow::Settings::refreshRate

Refresh rate for full-screen, in cycles/sec.

If zero, the display can choose its own refresh.

bool G3D::OSWindow::Settings::resizable

If true, you should set up your event loop as described in the docs for RenderDevice::resize.

int G3D::OSWindow::Settings::rgbBits

The number of bits in each color channel of the frame buffer.

5, 8.

bool G3D::OSWindow::Settings::sharedContext

If true, Texture and AttributeArray data will be shared between multiple OpenGL contexts.

This is necessary if your application makes multiple OS windows with their own OpenGL contexts. The default is false, which is essential for performance on multi-GPU systems.

int G3D::OSWindow::Settings::stencilBits

8

bool G3D::OSWindow::Settings::stereo

Allocate a stereo display context.

true, false

bool G3D::OSWindow::Settings::visible

When true, the window begins visible.

true, false.

int G3D::OSWindow::Settings::width

Width of the client area in pixels.

int G3D::OSWindow::Settings::x

Initial x position of the client area in screen space (can be overridden by fullScreen and center)

int G3D::OSWindow::Settings::y

Initial y position of the client area in screen space (can be overridden by fullScreen and center)