LLGL::WindowDescriptor Struct Reference

Window descriptor structure. More...

#include <WindowFlags.h>

Public Attributes
UTF8String	title
	Window title in UTF-8 encoding.
Offset2D	position
	Window position (relative to the client area).
Extent2D	size
	Specifies the content size (in window coordinates) of the window.
long	flags = 0
	Specifies the window creation flags. This can be a bitwise OR combination of the WindowFlags entries.
const void *	windowContext = nullptr
	Window context handle.
std::size_t	windowContextSize = 0
	Specifies the size (in bytes) of the data type windowContext points to.

Detailed Description

Window descriptor structure.

See also

Window::Create

Member Data Documentation

flags

long LLGL::WindowDescriptor::flags = 0

Specifies the window creation flags. This can be a bitwise OR combination of the WindowFlags entries.

See also

WindowFlags

position

Offset2D LLGL::WindowDescriptor::position

Window position (relative to the client area).

size

Extent2D LLGL::WindowDescriptor::size

Specifies the content size (in window coordinates) of the window.

Remarks

The content size does not including the frame and caption dimensions.

See also

Display::GetScale

WindowFlags::DisableSizeScaling

title

UTF8String LLGL::WindowDescriptor::title

Window title in UTF-8 encoding.

windowContext

const void* LLGL::WindowDescriptor::windowContext = nullptr

Window context handle.

Remarks

If used, this must be casted from a platform specific structure:

#include <LLGL/Platform/NativeHandle.h>
//...
LLGL::NativeHandle myParentWindowHandle;
myParentWindow->GetNativeHandle(&myParentWindowHandle, sizeof(myParentWindowHandle));
windowDesc.windowContext        = &myParentWindowHandle;
windowDesc.windowContextSize    = sizeof(myParentWindowHandle);

windowContextSize

std::size_t LLGL::WindowDescriptor::windowContextSize = 0

Specifies the size (in bytes) of the data type windowContext points to.

Remarks

If windowContext is non-null, this must be equal to sizeof(LLGL::NativeHandle).

See also

windowContext

---

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

• WindowFlags.h