ork::Window::Parameters Class Reference
A set of Window parameters.
More...
#include <Window.h>
List of all members.
Public Member Functions |
| | Parameters () |
| | Creates a new set of Window parameters.
|
| string | name () const |
| | Returns the window name.
|
| int | width () const |
| | Returns the window width.
|
| int | height () const |
| | Returns the window height.
|
| vec2< int > | version () const |
| | Returns the OpenGL version to use.
|
| bool | debug () const |
| | Returns true if a debug OpenGL context must be used.
|
| bool | alpha () const |
| | Returns true if the default framebuffer must have an alpha channel.
|
| bool | depth () const |
| | Returns true if the default framebuffer must have a depth buffer.
|
| bool | stencil () const |
| | Returns true if the default framebuffer must have as stencil buffer.
|
| bool | multiSample () const |
| | Returns true if the default framebuffer must use multisampling.
|
| Parameters & | name (const string name) |
| | Sets the window name.
|
| Parameters & | size (int width, int height) |
| | Sets the window size.
|
| Parameters & | version (int major, int minor, bool debug=false) |
| | Sets the OpenGL context options.
|
| Parameters & | alpha (bool alpha=true) |
| | Sets the alpha channel option for the default framebuffer.
|
| Parameters & | depth (bool depth=true) |
| | Sets the depth buffer option for the default framebuffer.
|
| Parameters & | stencil (bool stencil=true) |
| | Sets the stencil buffer option for the default framebuffer.
|
| Parameters & | multiSample (bool multiSample=true) |
| | Sets the multisampling option for the default framebuffer.
|
Detailed Description
A set of Window parameters.
Constructor & Destructor Documentation
| ork::Window::Parameters::Parameters |
( |
|
) |
|
Creates a new set of Window parameters.
Member Function Documentation
| Parameters& ork::Window::Parameters::alpha |
( |
bool |
alpha = true |
) |
|
Sets the alpha channel option for the default framebuffer.
- Parameters:
-
| alpha | true to use an alpha channel. |
| bool ork::Window::Parameters::alpha |
( |
|
) |
const |
Returns true if the default framebuffer must have an alpha channel.
| bool ork::Window::Parameters::debug |
( |
|
) |
const |
Returns true if a debug OpenGL context must be used.
| Parameters& ork::Window::Parameters::depth |
( |
bool |
depth = true |
) |
|
Sets the depth buffer option for the default framebuffer.
- Parameters:
-
| depth | true to use a depth buffer. |
| bool ork::Window::Parameters::depth |
( |
|
) |
const |
Returns true if the default framebuffer must have a depth buffer.
| int ork::Window::Parameters::height |
( |
|
) |
const |
Returns the window height.
| Parameters& ork::Window::Parameters::multiSample |
( |
bool |
multiSample = true |
) |
|
Sets the multisampling option for the default framebuffer.
- Parameters:
-
| multiSample | true to use multisampling. |
| bool ork::Window::Parameters::multiSample |
( |
|
) |
const |
Returns true if the default framebuffer must use multisampling.
| Parameters& ork::Window::Parameters::name |
( |
const string |
name |
) |
|
Sets the window name.
- Parameters:
-
| string ork::Window::Parameters::name |
( |
|
) |
const |
| Parameters& ork::Window::Parameters::size |
( |
int |
width, |
|
|
int |
height | |
|
) |
| | |
Sets the window size.
- Parameters:
-
| width | the window width. |
| height | the window height. |
| Parameters& ork::Window::Parameters::stencil |
( |
bool |
stencil = true |
) |
|
Sets the stencil buffer option for the default framebuffer.
- Parameters:
-
| stencil | true to use a stencil buffer. |
| bool ork::Window::Parameters::stencil |
( |
|
) |
const |
Returns true if the default framebuffer must have as stencil buffer.
| Parameters& ork::Window::Parameters::version |
( |
int |
major, |
|
|
int |
minor, |
|
|
bool |
debug = false | |
|
) |
| | |
Sets the OpenGL context options.
- Parameters:
-
| major | the major version to use. |
| minor | the minor version to use. |
| debug | true to use a debug context. |
| vec2<int> ork::Window::Parameters::version |
( |
|
) |
const |
Returns the OpenGL version to use.
| int ork::Window::Parameters::width |
( |
|
) |
const |
Returns the window width.
