Table of Contents

Class Window.PropertyNames

Namespace
Sdl3Sharp.Video.Windowing
Assembly
Sdl3Sharp.dll

Provides property names for Window properties

public abstract class Window.PropertyNames
Inheritance
Window.PropertyNames
Derived
Inherited Members

Fields

CreateAlwaysOnTopBoolean

The name of a property used when creating a that holds a value indicating whether the window should always be above other windows

public const string CreateAlwaysOnTopBoolean = "SDL.window.create.always_on_top"

Field Value

string

CreateBorderlessBoolean

The name of a property used when creating a that holds a value indicating whether the window should be created without a border (without decorations)

public const string CreateBorderlessBoolean = "SDL.window.create.borderless"

Field Value

string

CreateConstrainPopupBoolean

The name of a property used when creating a that holds a value indicating whether a "tooltip" or "menu" popup window should be automatically constrained to the bounds of the display

public const string CreateConstrainPopupBoolean = "SDL.window.create.constrain_popup"

Field Value

string

Remarks

The default value for the associated property, if not specified otherwise when creating a window, is true.

CreateExternalGraphicsContextBoolean

The name of a property used when creating a that holds a value indicating whether the window will be used with an externally managed graphics context

public const string CreateExternalGraphicsContextBoolean = "SDL.window.create.external_graphics_context"

Field Value

string

CreateFlagsNumber

The name of a property used when creating a that holds the WindowFlags to be used when creating the window

public const string CreateFlagsNumber = "SDL.window.create.flags"

Field Value

string

CreateFocusableBoolean

The name of a property used when creating a that holds a value indicating whether the window should accept input focus

public const string CreateFocusableBoolean = "SDL.window.create.focusable"

Field Value

string

Remarks

The default value for the associated property, if not specified otherwise when creating a window, is true.

CreateFullscreenBoolean

The name of a property used when creating a that holds a value indicating whether the window should be created initially in fullscreen mode at desktop resolution

public const string CreateFullscreenBoolean = "SDL.window.create.fullscreen"

Field Value

string

CreateHeightNumber

The name of a property used when creating a that holds the height of the window

public const string CreateHeightNumber = "SDL.window.create.height"

Field Value

string

CreateHiddenBoolean

The name of a property used when creating a that holds a value indicating whether the window should be created initially hidden

public const string CreateHiddenBoolean = "SDL.window.create.hidden"

Field Value

string

CreateHighPixelDensityBoolean

The name of a property used when creating a that holds a value indicating whether the window should be created with a high pixel density buffer, if possible

public const string CreateHighPixelDensityBoolean = "SDL.window.create.high_density"

Field Value

string

CreateMaximizedBoolean

The name of a property used when creating a that holds a value indicating whether the window should be created initially maximized

public const string CreateMaximizedBoolean = "SDL.window.create.maximized"

Field Value

string

CreateMenuBoolean

The name of a property used when creating a that holds a value determining whether the window should be created as a "menu" popup window

public const string CreateMenuBoolean = "SDL.window.create.menu"

Field Value

string

Remarks

If the value of the associated property is set to true, you must specify a parent window for the window to be created.

CreateMetalBoolean

The name of a property used when creating a that holds a value indicating whether the window will be used with Metal rendering

public const string CreateMetalBoolean = "SDL.window.create.metal"

Field Value

string

CreateMinimizedBoolean

The name of a property used when creating a that holds a value indicating whether the window should be created initially minimized

public const string CreateMinimizedBoolean = "SDL.window.create.minimized"

Field Value

string

CreateModalBoolean

The name of a property used when creating a that holds a value indicating whether the window should be created as modal to its parent window

public const string CreateModalBoolean = "SDL.window.create.modal"

Field Value

string

Remarks

If the value of the associated property is set to true, you must specify a parent window for the window to be created.

CreateMouseGrabbedBoolean

The name of a property used when creating a that holds a value indicating whether the window should be created initially with the mouse grabbed

public const string CreateMouseGrabbedBoolean = "SDL.window.create.mouse_grabbed"

Field Value

string

CreateOpenGLBoolean

The name of a property used when creating a that holds a value indicating whether the window will be used with OpenGL rendering

public const string CreateOpenGLBoolean = "SDL.window.create.opengl"

Field Value

string

CreateParentPointer

The name of a property used when creating a that holds a pointer to the parent Window of the window to be created

public const string CreateParentPointer = "SDL.window.create.parent"

Field Value

string

Remarks

You must specify a valid pointer as the value for the associated property when you want to create a "tooltip" or "menu" popup window or a window that should be modal to its parent window.

CreateResizableBoolean

The name of a property used when creating a that holds a value indicating whether the window should be resizable by the user

public const string CreateResizableBoolean = "SDL.window.create.resizable"

Field Value

string

CreateTitleString

The name of a property used when creating a that holds the title of the window

public const string CreateTitleString = "SDL.window.create.title"

Field Value

string

Remarks

Depending on the platform and windowing backend, Unicode characters may be allowed in the window title.

CreateTooltipBoolean

The name of a property used when creating a that holds a value indicating whether the window should be created as a "tooltip" popup window

public const string CreateTooltipBoolean = "SDL.window.create.tooltip"

Field Value

string

CreateTransparentBoolean

The name of a property used when creating a that holds a value indicating whether the window should be created with a transparent buffer

public const string CreateTransparentBoolean = "SDL.window.create.transparent"

Field Value

string

Remarks

The associated property will determine whether the window will be shown transparent in areas where the alpha channel value of the window's buffer is equal to 0.

CreateUtilityBoolean

The name of a property used when creating a that holds a value indicating whether the window should be created as a utility window (e.g. not showing in the task bar and window list)

public const string CreateUtilityBoolean = "SDL.window.create.utility"

Field Value

string

CreateVulkanBoolean

The name of a property used when creating a that holds a value indicating whether the window will be used with Vulkan rendering

public const string CreateVulkanBoolean = "SDL.window.create.vulkan"

Field Value

string

CreateWidthNumber

The name of a property used when creating a that holds the width of the window

public const string CreateWidthNumber = "SDL.window.create.width"

Field Value

string

CreateXNumber

The name of a property used when creating a that holds the X coordinate of the window, Centered, Undefined, or a value obtained from using the CenteredOn(Display) or UndefinedOn(Display) methods

public const string CreateXNumber = "SDL.window.create.x"

Field Value

string

Remarks

You can either specify definitive coordinates as the value for the associated property, or you can use Centered, Undefined, CenteredOn(Display), or UndefinedOn(Display) to specify some special window positions to be determined in relation to the primary display or a specific display.

CreateYNumber

The name of a property used when creating a that holds the Y coordinate of the window, Centered, Undefined, or a value obtained from using the CenteredOn(Display) or UndefinedOn(Display) methods

public const string CreateYNumber = "SDL.window.create.y"

Field Value

string

Remarks

You can either specify definitive coordinates as the value for the associated property, or you can use Centered, Undefined, CenteredOn(Display), or UndefinedOn(Display) to specify some special window positions to be determined in relation to the primary display or a specific display.

HdrEnabledBoolean

The name of a read-only property that holds a value indicating whether the window has HDR headroom above the SDR white level

public const string HdrEnabledBoolean = "SDL.window.HDR_enabled"

Field Value

string

Remarks

The value of the associated property can change dynamically at runtime when a WindowHdrStateChanged event is sent.

HdrHeadroomFloat

The name of a read-only property that holds the additional high dynamic range that can be displayed, in terms of the SDR white level

public const string HdrHeadroomFloat = "SDL.window.HDR_headroom"

Field Value

string

Remarks

The value of the associated property will be 1.0 when HDR is not enabled. This property can change dynamically at runtime when a WindowHdrStateChanged event (WindowEvent) is sent.

SdrWhiteLevelFloat

The name of a read-only property that holds the value of the SDR white in the Srgb color space for the window

public const string SdrWhiteLevelFloat = "SDL.window.SDR_white_level"

Field Value

string

Remarks

On Windows the value of the associated property corresponds to the SDR white level in scRGB color space, and on Apple platform this is always 1.0 for EDR content. This property can change dynamically at runtime when a WindowHdrStateChanged event (WindowEvent) is sent.

ShapePointer

The name of a read-only property that holds a pointer to the shape that's associated with the window

public const string ShapePointer = "SDL.window.shape"

Field Value

string

Remarks

See Shape for more information about window shapes.

Edit this page