Table of Contents

Struct WindowEvent

Namespace
Sdl3Sharp.Events
Assembly
Sdl3Sharp.dll

Represents an event that occurs when a Window changes its state

public struct WindowEvent : ICommonEvent<WindowEvent>, ICommonEvent, ISpanFormattable, IFormattable
Implements
Inherited Members

Remarks

Associated EventTypes:

Properties

Data1

Gets or sets the value of the first event dependent data slot

public int Data1 { readonly get; set; }

Property Value

int

The value of the first event dependent data slot

Remarks

The value of this property may reflect different data semantics dependent on the Type:

  • WindowExposed 1 for "live-resize expose" events; otherwise, 0
  • WindowMoved The new horizontal coordinate of the Window after it has been moved
  • WindowResized The new width of the Window after it has been resized
  • WindowPixelSizeChanged The new horizontal pixel size of the Window after it has been changed

Data2

Gets or sets the value of the second event dependent data slot

public int Data2 { readonly get; set; }

Property Value

int

The value of the second event dependent data slot

Remarks

The value of this property may reflect different data semantics dependent on the Type:

  • WindowMoved The new vertical coordinate of the Window after it has been moved
  • WindowResized The new height of the Window after it has been resized
  • WindowPixelSizeChanged The new vertical pixel size of the Window after it has been changed

Timestamp

Gets or sets the timestamp of the current event

public ulong Timestamp { readonly get; set; }

Property Value

ulong

The timestamp of the current event, in nanoseconds in nanoseconds since the initialization of SDL

Remarks

The value of this property usually describes the time passed, in nanoseconds since the initialization of SDL. It can be properly populated by using NanosecondTicks.

Type

Gets or sets the type of the current event

public EventType Type { readonly get; set; }

Property Value

EventType

The type of the current event

Remarks

When setting this property, the value must be one of the EventType.Window* values. Otherwise, it will lead the property to throw an ArgumentException!

Exceptions

ArgumentException

When setting this property, the value was not one of the EventType.Window* values

WindowId

Gets or sets the window ID of the Window which changes it's state

public uint WindowId { readonly get; set; }

Property Value

uint

The window ID of the Window which changes it's state

Methods

ToString()

Returns the fully qualified type name of this instance.

public override readonly string ToString()

Returns

string

The fully qualified type name.

ToString(IFormatProvider?)

Formats the value of the current instance using the specified format.

public readonly string ToString(IFormatProvider? formatProvider)

Parameters

formatProvider IFormatProvider

The provider to use to format the value.

-or-

A null reference (Nothing in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system.

Returns

string

The value of the current instance in the specified format.

ToString(string?)

Formats the value of the current instance using the specified format.

public readonly string ToString(string? format)

Parameters

format string

The format to use.

-or-

A null reference (Nothing in Visual Basic) to use the default format defined for the type of the IFormattable implementation.

Returns

string

The value of the current instance in the specified format.

ToString(string?, IFormatProvider?)

Formats the value of the current instance using the specified format.

public readonly string ToString(string? format, IFormatProvider? formatProvider)

Parameters

format string

The format to use.

-or-

A null reference (Nothing in Visual Basic) to use the default format defined for the type of the IFormattable implementation.

formatProvider IFormatProvider

The provider to use to format the value.

-or-

A null reference (Nothing in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system.

Returns

string

The value of the current instance in the specified format.

TryFormat(Span<char>, out int, ReadOnlySpan<char>, IFormatProvider?)

Tries to format the value of the current instance into the provided span of characters.

public readonly bool TryFormat(Span<char> destination, out int charsWritten, ReadOnlySpan<char> format = default, IFormatProvider? provider = null)

Parameters

destination Span<char>

The span in which to write this instance's value formatted as a span of characters.

charsWritten int

When this method returns, contains the number of characters that were written in destination.

format ReadOnlySpan<char>

A span containing the characters that represent a standard or custom format string that defines the acceptable format for destination.

provider IFormatProvider

An optional object that supplies culture-specific formatting information for destination.

Returns

bool

true if the formatting was successful; otherwise, false.

Operators

explicit operator WindowEvent(in Event)

Converts a general Event to an event of type WindowEvent

public static explicit operator WindowEvent(in Event @event)

Parameters

event Event

The general Event to convert to an event of type WindowEvent

Returns

WindowEvent

Remarks

The Type of the given event must be one of the EventType.Window* values. Otherwise, it will lead the method to throw an ArgumentException!

Exceptions

ArgumentException

The Type of the given event was not one of the EventType.Window* values

implicit operator Event(in WindowEvent)

Converts an event of type WindowEvent to a general Event

public static implicit operator Event(in WindowEvent @event)

Parameters

event WindowEvent

The event of type WindowEvent to convert to a general Event

Returns

Event

Remarks

This conversion usually requires the event to be copied into a new general Event structure. Note: This can impact performance!

Edit this page