Class for creating a window. More...

#include <Window.hpp>

Public Member Functions
MYGL_EXPORT	Window ()
	Default constructor, creates a 800 * 600 window.

MYGL_EXPORT	Window (int width, int height, const std::string &title, unsigned int flags=my::WindowFlag::none, int antiAliasing=0, int GLVersionMajor=3, int GLVersionMinor=3)
	Creates a window.

MYGL_EXPORT bool	isRunning () const noexcept
	Tells wheter a window is opened or closed.

MYGL_EXPORT void	close ()
	Closes a window.

MYGL_EXPORT bool	pollEvent (my::Event &e)
	retrieves the event in front of the event queue

MYGL_EXPORT void	setActive () noexcept
	Sets the window's OpenGL context current.

MYGL_EXPORT void	setFramerate (unsigned int limit)
	Limit the window's framerate at the specified value, a call to this method will disable vsync if it was previously enabled.

MYGL_EXPORT void	enableVsync (bool enable)
	Enable or disable vsync, enabling vsync will override the framerate limit if it was previously set.

MYGL_EXPORT void	clear (const my::Color &color) const
	Clears the window's content and replaces it with a background color.

MYGL_EXPORT void	setClipPlanes (float left, float right, float bottom, float top)
	Sets the dimensions of the window's projection matrix's frustum.

MYGL_EXPORT void	setViewport (int x, int y, int width, int height)
	Sets the viewport's position and size.

MYGL_EXPORT void	setCamera (my::Camera &camera) noexcept
	Sets the camera used by this window.

MYGL_EXPORT my::Camera &	getCamera () noexcept
	Returns the currently bound camera.

MYGL_EXPORT void	setSize (unsigned int width, unsigned int height, bool resizeViewport=false)
	Sets the size of the window's rendering area.

MYGL_EXPORT glm::ivec2	getSize () const noexcept
	Gives the window's size.

MYGL_EXPORT void	setIcon (const Image &icon)
	Sets the window's icon.

MYGL_EXPORT void	setCursor (const Cursor &cursor) noexcept
	Sets the cursor used by this window.

MYGL_EXPORT void	draw (my::AbstractShape &shape) const
	Draws a shape.

MYGL_EXPORT void	display () const
	Refreshes the window to display all the things which have been drawn.

MYGL_EXPORT double	getFrametime () const
	Indicates the time that the last frame took to render.

Static Public Member Functions
static void *	getGLProcAdress (const char *name)

Detailed Description

Class for creating a window.

Definition at line 51 of file Window.hpp.

Constructor & Destructor Documentation

◆ Window()

MYGL_EXPORT Window	(	int	width,
		int	height,
		const std::string &	title,
		unsigned int	flags = my::WindowFlag::none,
		int	antiAliasing = 0,
		int	GLVersionMajor = 3,
		int	GLVersionMinor = 3 )

Creates a window.

Parameters

width	The window's width
height	The window's height
title	The window's title
flags	A combination of WindowFlags, you can specify multiple properties using a bitwise or, for example if you want your window to be resizable and to always be on top you would pass "my::resizable \| my::floating" as the flags parameter
antiAliasing	The anti aliasing level, should be 0 (disabled), 2, 4 or 8. Defaults to 0
GLVersionMajor	The minor version of the desired OpenGL version, supported OpenGL versions are 3.3 and 4.0 to 4.6
GLVersionMinor	The minor version of the desired OpenGL version, supported OpenGL versions are 3.3 and 4.0 to 4.6

Member Function Documentation

◆ clear()

MYGL_EXPORT void clear ( const my::Color & color ) const

Clears the window's content and replaces it with a background color.

Parameters

color The background color

◆ draw()

MYGL_EXPORT void draw ( my::AbstractShape & shape ) const

Draws a shape.

Parameters

shape The shape to draw, it must inherit from AbstractShape

◆ enableVsync()

MYGL_EXPORT void enableVsync ( bool enable )

Enable or disable vsync, enabling vsync will override the framerate limit if it was previously set.

Parameters

enable True to enable vsync, false to disable it

◆ getCamera()

MYGL_EXPORT my::Camera & getCamera ( )

noexcept

Returns the currently bound camera.

Returns: A reference to the camera which is currently attached to the window

◆ getFrametime()

MYGL_EXPORT double getFrametime ( ) const

Indicates the time that the last frame took to render.

Returns: The window's frametime in seconds

◆ getSize()

MYGL_EXPORT glm::ivec2 getSize ( ) const

noexcept

Gives the window's size.

Returns: The size of the window's viewport (rendering area) in pixels

◆ isRunning()

MYGL_EXPORT bool isRunning ( ) const

noexcept

Tells wheter a window is opened or closed.

Returns: true if the window is opened, false if it is closed

◆ pollEvent()

MYGL_EXPORT bool pollEvent ( my::Event & e )

retrieves the event in front of the event queue

Parameters

e	A my::Event which will hold the event's value

Returns: false if there was no event in the queue, true otherwise

◆ setCamera()

MYGL_EXPORT void setCamera ( my::Camera & camera )

noexcept

Sets the camera used by this window.

Parameters

camera The camera which will be used to see the window's content

◆ setClipPlanes()

MYGL_EXPORT void setClipPlanes	(	float	left,
		float	right,
		float	bottom,
		float	top )

Sets the dimensions of the window's projection matrix's frustum.

Parameters

left	The frustum's left coordinate
right	The frustum's right coordinate
bottom	The frustum's bottom coordinate
top	The frustum's top coordinate

◆ setCursor()

MYGL_EXPORT void setCursor ( const Cursor & cursor )

noexcept

Sets the cursor used by this window.

Parameters

cursor The new cursor to use

◆ setFramerate()

MYGL_EXPORT void setFramerate ( unsigned int limit )

Limit the window's framerate at the specified value, a call to this method will disable vsync if it was previously enabled.

Parameters

limit The framerate limit, 0 means unlimited

◆ setIcon()

MYGL_EXPORT void setIcon ( const Image & icon )

Sets the window's icon.

Parameters

icon	The image to set as the new window icon, it must have 4 channels (RGBA). Passing a default constructed or an invalid Image will revert to the default window icon

◆ setSize()

MYGL_EXPORT void setSize	(	unsigned int	width,
		unsigned int	height,
		bool	resizeViewport = false )

Sets the size of the window's rendering area.

This function only modifies the size of the window, you should then handle the size of the projection matrix and

Parameters

width	The new width
height	The new height
resizeViewport	If true, the function will set the clip planes and viewport to the same size as the window (with a call to setClipPlanes(0, width, 0, height) and setViewport(0, 0, width, height)

◆ setViewport()

MYGL_EXPORT void setViewport	(	int	x,
		int	y,
		int	width,
		int	height )

Sets the viewport's position and size.

This is equivalent to calling glViewport(left, bottom, width, height) The left and bottom parameters are in the OpenGL coordinate system (origin is the bottom left corner, upwards y axis)

Parameters

x	The viewport's lower left corner's x position
y	The viewport's lower left corner's y position
width	The viewport's width
height	The viewport's height

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

Window.hpp

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Window()

Member Function Documentation

◆ clear()

◆ draw()

◆ enableVsync()

◆ getCamera()

◆ getFrametime()

◆ getSize()

◆ isRunning()

◆ pollEvent()

◆ setCamera()

◆ setClipPlanes()

◆ setCursor()

◆ setFramerate()

◆ setIcon()

◆ setSize()

◆ setViewport()