Struct MouseButtonEvent

Namespace

Sdl3Sharp.Events

Assembly

Sdl3Sharp.dll

Represents an event that occurs when a mouse button is being pressed or released

public struct MouseButtonEvent : ICommonEvent<MouseButtonEvent>, ICommonEvent, ISpanFormattable, IFormattable

Implements

ICommonEvent<MouseButtonEvent>

ICommonEvent

ISpanFormattable

IFormattable

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Remarks

Associated EventTypes:

• MouseButtonDown
• MouseButtonUp

Properties

Button

Gets or sets the mouse button

public MouseButton Button { readonly get; set; }

Property Value

MouseButton

The mouse button

Clicks

Gets or sets the number of repeated clicks

public byte Clicks { readonly get; set; }

Property Value

byte

The number of repeated clicks

Remarks

1 for a single-click, 2 for a double-click, etc.

IsDown

Gets or sets a value indicating whether the button is pressed

public bool IsDown { readonly get; set; }

Property Value

bool

A value indicating whether the button is pressed

MouseId

Gets or sets the mouse device ID for the Mouse associated with the event

public uint MouseId { readonly get; set; }

Property Value

uint

The mouse device ID for the Mouse associated with the event, SDL_TOUCH_MOUSEID for touch events, or 0

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 either MouseButtonDown or MouseButtonUp. Otherwise, it will lead the property to throw an ArgumentException!

Exceptions

ArgumentException

When setting this property, the value was neither MouseButtonDown nor MouseButtonUp

WindowId

Gets or sets the window Id of the Window with mouse focus, if any

public uint WindowId { readonly get; set; }

Property Value

uint

The window Id of the Window with mouse focus, if any, or 0

X

Gets or sets the X coordinate of the mouse cursor

public float X { readonly get; set; }

Property Value

float

The X coordinate of the mouse cursor, relative to the Window specified through WindowId

Y

Gets or sets the Y coordinate of the mouse cursor

public float Y { readonly get; set; }

Property Value

float

The Y coordinate of the mouse cursor, relative to the Window specified through WindowId

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 MouseButtonEvent(in Event)

Converts a general Event to an event of type MouseButtonEvent

public static explicit operator MouseButtonEvent(in Event @event)

Parameters

event Event

The general Event to convert to an event of type MouseButtonEvent

Returns

MouseButtonEvent

Remarks

The Type of the given event must be either MouseButtonDown or MouseButtonUp. Otherwise, it will lead the method to throw an ArgumentException!

Exceptions

ArgumentException

The Type of the given event was neither MouseButtonDown nor MouseButtonUp

implicit operator Event(in MouseButtonEvent)

Converts an event of type MouseButtonEvent to a general Event

public static implicit operator Event(in MouseButtonEvent @event)

Parameters

event MouseButtonEvent

The event of type MouseButtonEvent 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!