class ffw::RenderWindow

Class List > ffw :: RenderWindow

Inherited by the following classes: ffw::GLRenderWindow

Public Functions

Type Name
virtual ~RenderWindow () = default
virtual void * getGlextFunc (const std::string & name) const = 0
Retuns the address of the GL extension function.
virtual bool isGlextExtSupported (const std::string & name) const = 0
Returns true if the GL extension is suported.
virtual void setPos (int posx, int posy) = 0
Sets the position of the window.
virtual void setSize (int width, int height) = 0
Sets the size of the window.
virtual Vec2< int > getPos () const = 0
virtual Vec2< int > getSize () const = 0
virtual bool shouldRender () const = 0
Returns true if the window is not closed.
virtual void renderFrame () = 0
Renders a frame.
virtual void poolEvents () = 0
Pools all user input events, if any.
virtual void waitForEvents () = 0
Pools all user input events and waits if there is none.
virtual bool isInitialized () const = 0
Returns true if the window is initialized.
virtual void shouldClose (bool close) = 0
Set whether the window should close or stay alive.
virtual void show () = 0
Shows the window if the window has been hidden.
virtual void hide () = 0
Hides the window if the window is visible.
virtual void iconify () = 0
Minimizes the window into the task bar.
virtual void restore () = 0
Restores minimized window into a visible window.
virtual void maximize () = 0
Maximizes the window in order to utilize whole screen.
virtual void setSingleBufferMode (bool enabled) = 0
Sets whether the window should operate using two buffets (back and front) or only in one.

Public Functions Documentation

function ~RenderWindow

virtual ffw::RenderWindow::~RenderWindow () = default

function getGlextFunc

virtual void * ffw::RenderWindow::getGlextFunc (
    const std::string & name
) const = 0

Retuns the address of the GL extension function.

The pointer to the GL extension function may not be the same on different GL contexts!

function isGlextExtSupported

virtual bool ffw::RenderWindow::isGlextExtSupported (
    const std::string & name
) const = 0

Returns true if the GL extension is suported.

Checks if an GLEXT extension is supported, for example "GL_ARB_debug_output"

function setPos

virtual void ffw::RenderWindow::setPos (
    int posx,
    int posy
) = 0

Sets the position of the window.

function setSize

virtual void ffw::RenderWindow::setSize (
    int width,
    int height
) = 0

Sets the size of the window.

function getPos

virtual Vec2< int > ffw::RenderWindow::getPos () const = 0

function getSize

virtual Vec2< int > ffw::RenderWindow::getSize () const = 0

function shouldRender

virtual bool ffw::RenderWindow::shouldRender () const = 0

Returns true if the window is not closed.

When shouldClose() is called with a 'true' boolean value, this function will then return false

function renderFrame

virtual void ffw::RenderWindow::renderFrame () = 0

Renders a frame.

function poolEvents

virtual void ffw::RenderWindow::poolEvents () = 0

Pools all user input events, if any.

This is blocking function that will return whenever there are any events in the queue. If you wish to wait for the user first, see waitForEvents()

function waitForEvents

virtual void ffw::RenderWindow::waitForEvents () = 0

Pools all user input events and waits if there is none.

This is blocking function that will not return unless there is at least one user event. If you wish to have continuous rendering, even if there are no user events, use poolEvents()

function isInitialized

virtual bool ffw::RenderWindow::isInitialized () const = 0

Returns true if the window is initialized.

function shouldClose

virtual void ffw::RenderWindow::shouldClose (
    bool close
) = 0

Set whether the window should close or stay alive.

function show

virtual void ffw::RenderWindow::show () = 0

Shows the window if the window has been hidden.

function hide

virtual void ffw::RenderWindow::hide () = 0

Hides the window if the window is visible.

function iconify

virtual void ffw::RenderWindow::iconify () = 0

Minimizes the window into the task bar.

function restore

virtual void ffw::RenderWindow::restore () = 0

Restores minimized window into a visible window.

function maximize

virtual void ffw::RenderWindow::maximize () = 0

Maximizes the window in order to utilize whole screen.

This is not the same as full screen mode!

function setSingleBufferMode

virtual void ffw::RenderWindow::setSingleBufferMode (
    bool enabled
) = 0

Sets whether the window should operate using two buffets (back and front) or only in one.


The documentation for this class was generated from the following file: include/ffw/graphics/renderwindow.h