core::data::window class

contains the data to initialize a core::os::surface

member-functions

width
returns the width in pixels.
const public
width
sets the width in pixels.
public
height
returns the height in pixels.
const public
height
sets the height in pixels.
public
name
returns the name of the surface.
const public
name
sets the name of the surface.
public
mode
returns the current mode of rendering.
const public
mode
sets the current mode of rendering.
public
buffering
returns the current buffering behaviour of this instance.
const public
buffering
sets the buffering behaviour of this instance.
public

Function documentation

uint32_t core::data::window::width() const

Brief

returns the width in pixels.

Returns the width in pixels.

void core::data::window::width(uint32_t width)

Brief

sets the width in pixels.

Details

Parameters
width in the value to set.

uint32_t core::data::window::height() const

Brief

returns the height in pixels.

Returns the height in pixels.

void core::data::window::height(uint32_t height)

Brief

sets the height in pixels.

Details

Parameters
height in the value to set.

psl::string8::view core::data::window::name() const

Brief

returns the name of the surface.

Returns the name of the surface.

void core::data::window::name(psl::string8::view name)

Brief

sets the name of the surface.

Details

Parameters
name in the name to set this instance's value to.

core::gfx::surface_mode core::data::window::mode() const

Brief

returns the current mode of rendering.

Returns the current mode of rendering.

void core::data::window::mode(core::gfx::surface_mode mode)

Brief

sets the current mode of rendering.

Parameters
mode in the mode to set this instance's value to.

core::gfx::buffering core::data::window::buffering() const

Brief

returns the current buffering behaviour of this instance.

Returns the current buffering behaviour of this instance.

void core::data::window::buffering(core::gfx::buffering mode)

Brief

sets the buffering behaviour of this instance.

Parameters
mode in the mode to set this instance's value to.