Interface IDisplay
Display / Window Operations: Resolution, Position, Title, State
Namespace: Yak2D
Assembly: Yak2D.Api.dll
Syntax
public interface IDisplayProperties
DisplayState
Returns current window state
Declaration
DisplayState DisplayState { get; }Property Value
| Type | Description |
|---|---|
| DisplayState |
WindowBorderVisible
Controls window border visibility
Declaration
bool WindowBorderVisible { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
WindowIsInFocus
Returns whether application window is currently in focus
Declaration
bool WindowIsInFocus { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
WindowOpacity
Window opactiy on desktop
Declaration
float WindowOpacity { get; set; }Property Value
| Type | Description |
|---|---|
| System.Single |
WindowPositionX
X Location of left edge of Window of Desktop
Declaration
int WindowPositionX { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
WindowPositionY
Y Location of left edge of Window of Desktop Note: Certain desktops (including Gnome and KDE when tested) appear to read this as the top of the visible client area, but set as the top of the entire window including title bar
Declaration
int WindowPositionY { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
WindowResizable
Controls whether the window is user resizable
Declaration
bool WindowResizable { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
WindowResolutionHeight
Returns current window pixel height
Declaration
uint WindowResolutionHeight { get; }Property Value
| Type | Description |
|---|---|
| System.UInt32 |
WindowResolutionWidth
Returns current window pixel width
Declaration
uint WindowResolutionWidth { get; }Property Value
| Type | Description |
|---|---|
| System.UInt32 |
Methods
SetCursorVisible(Boolean)
Sets whether the cursor is visible over the window area
Declaration
void SetCursorVisible(bool visible)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | visible | Cursor visibility" |
SetDisplayState(DisplayState)
Sets display state
Declaration
void SetDisplayState(DisplayState state)Parameters
| Type | Name | Description |
|---|---|---|
| DisplayState | state | The desired window state |
SetVsync(Boolean)
Sets vsync
Declaration
void SetVsync(bool vsync)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | vsync | Vsync on or off" |
SetWindowResolution(UInt32, UInt32)
Sets windows pixel resolution
Declaration
void SetWindowResolution(uint width, uint height)Parameters
| Type | Name | Description |
|---|---|---|
| System.UInt32 | width | Width in pixels" |
| System.UInt32 | height | Height in pixels" |
SetWindowTitle(String)
Sets window title bar text
Declaration
void SetWindowTitle(string title)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | title | Title text" |