Public Types
enum	API { API_OPENGL, API_OPENGL_ES, API_VULKAN }

Public Member Functions
	Settings ()

const class ImageFormat *	colorFormat () const
	Computes the image format closest to these settings for the color buffer. More...

Public Attributes
bool	allowAlphaTest
	Enable support for pre-OpenGL 3 Core alpha test. More...

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) More...

int	alphaBits

bool	alwaysOnTop
	When true, the window is set to always be drawn on top of all others (unless they have the same property...). More...

API	api = API_OPENGL

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

String	caption
	Window title. More...

bool	center
	If true, overrides the x and y settings. More...

bool	coreContext
	If true, creates a core OpenGL profile. More...

bool	debugContext
	When true, uses a debug context. More...

String	defaultIconFilename
	Default icon that the OSWindow implementation tries to set initially. More...

int	depthBits
	0 (autodetect the best for this card), 16, 24, 32 More...

bool	forwardCompatibilityMode
	If true, all functionality deprecated in the requested version of OpenGL is removed. More...

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

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

std::string	fullScreenMonitorName
	If fullscreen = true, attempt to make a full screen on the monitor with this name. More...

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

int	height

int	majorGLVersion
	Settings to request a specific version of OpenGL. More...

int	minorGLVersion

int	msaaSamples
	Number of samples per pixel for anti-aliasing purposes. More...

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

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

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

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

int	stencilBits
	8 More...

bool	stereo
	Allocate a stereo display context. More...

bool	visible
	When true, the window begins visible. More...

int	width
	Width of the client area in pixels. More...

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

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

Member Enumeration Documentation

◆ API

enum G3D::OSWindow::Settings::API

Enumerator
API_OPENGL
API_OPENGL_ES
API_VULKAN

Constructor & Destructor Documentation

◆ Settings()

G3D::OSWindow::Settings::Settings ( )

Member Function Documentation

◆ colorFormat()

const class ImageFormat* G3D::OSWindow::Settings::colorFormat ( ) const

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

Member Data Documentation

◆ allowAlphaTest

bool G3D::OSWindow::Settings::allowAlphaTest

Enable support for pre-OpenGL 3 Core alpha test.

This is not allowed on OS X. False by default.

See also: RenderDevice::AlphaTest, RenderDevice::setAlphaTest

◆ allowMaximize

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)

◆ alphaBits

int G3D::OSWindow::Settings::alphaBits

◆ alwaysOnTop

bool G3D::OSWindow::Settings::alwaysOnTop

When true, the window is set to always be drawn on top of all others (unless they have the same property...).

true, false.

◆ api

API G3D::OSWindow::Settings::api = API_OPENGL

◆ asynchronous

bool G3D::OSWindow::Settings::asynchronous

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

True generally gives higher frame rates.

◆ caption

String G3D::OSWindow::Settings::caption

Window title.

◆ center

bool G3D::OSWindow::Settings::center

If true, overrides the x and y settings.

◆ coreContext

bool G3D::OSWindow::Settings::coreContext

If true, creates a core OpenGL profile.

Otherwise, creates a compatibility mode OpenGL profile.

◆ debugContext

bool G3D::OSWindow::Settings::debugContext

When true, uses a debug context.

true, false.

◆ defaultIconFilename

String G3D::OSWindow::Settings::defaultIconFilename

Default icon that the OSWindow implementation tries to set initially.

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

◆ depthBits

int G3D::OSWindow::Settings::depthBits

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

◆ forwardCompatibilityMode

bool G3D::OSWindow::Settings::forwardCompatibilityMode

If true, all functionality deprecated in the requested version of OpenGL is removed.

◆ framed

bool G3D::OSWindow::Settings::framed

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

◆ fullScreen

bool G3D::OSWindow::Settings::fullScreen

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

◆ fullScreenMonitorName

std::string G3D::OSWindow::Settings::fullScreenMonitorName

If fullscreen = true, attempt to make a full screen on the monitor with this name.

◆ hardware

bool G3D::OSWindow::Settings::hardware

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

◆ height

int G3D::OSWindow::Settings::height

◆ majorGLVersion

int G3D::OSWindow::Settings::majorGLVersion

Settings to request a specific version of OpenGL.

For example, to request OpenGL 4.1, set majorGLVersion = 4, and minorGLVersion = 1.

While there is no way to ask the driver for a context of the highest supported version, most drivers provide this when you ask GLFW for a version 1.0 context.

We default to 3.3 on OS X, and 1.0 on all other platforms.

◆ minorGLVersion

int G3D::OSWindow::Settings::minorGLVersion

◆ msaaSamples

int G3D::OSWindow::Settings::msaaSamples

Number of samples per pixel for anti-aliasing purposes.

1 (none), 4, 8

◆ refreshRate

int G3D::OSWindow::Settings::refreshRate

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

If less than or equal to, the display can choose its own refresh.

◆ resizable

bool G3D::OSWindow::Settings::resizable

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

◆ rgbBits

int G3D::OSWindow::Settings::rgbBits

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

5, 8.

◆ sharedContext

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.

◆ stencilBits

int G3D::OSWindow::Settings::stencilBits

8

◆ stereo

bool G3D::OSWindow::Settings::stereo

Allocate a stereo display context.

true, false

◆ visible

bool G3D::OSWindow::Settings::visible

When true, the window begins visible.

true, false.

◆ width

int G3D::OSWindow::Settings::width

Width of the client area in pixels.

◆ x

int G3D::OSWindow::Settings::x

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

◆ y

int G3D::OSWindow::Settings::y

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

Public Types

Public Member Functions

Public Attributes