Struct PenProximityEvent

Namespace

Sdl3Sharp.Events

Assembly

Sdl3Sharp.dll

Represents an event that occurs when a Pen enters or leaves proximity

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

Implements

ICommonEvent<PenProximityEvent>

ICommonEvent

ISpanFormattable

IFormattable

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Remarks

When a pen becomes visible to the system (it is close enough to a tablet, etc), SDL will send a PenProximityIn event with the new pen's ID. This ID is valid until the pen leaves proximity again (has been removed from the tablet's area, the tablet has been unplugged, etc). If the same pen reenters proximity again, it will be given a new ID.

Note that "proximity" means "close enough for the tablet to know the tool is there." The pen touching and lifting off from the tablet while not leaving the area are handled by PenDown and PenUp events (PenTouchEvent).

Notice that not all platforms have a window associated with the pen during proximity events. Some wait until motion/button/etc. events to offer this info.

Associated EventTypes:

• PenProximityIn
• PenProximityOut

Properties

PenId

Gets or sets the pen instance ID for the Pen associated with the event

public uint PenId { readonly get; set; }

Property Value

uint

The pen instance ID for the Pen associated with the event

Remarks

If a pen leaves proximity and later re-enters proximity, it may be assigned a different device ID.

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

Exceptions

ArgumentException

When setting this property, the value was neither PenProximityIn nor PenProximityOut

WindowId

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

public uint WindowId { readonly get; set; }

Property Value

uint

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

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

Converts a general Event to an event of type PenProximityEvent

public static explicit operator PenProximityEvent(in Event @event)

Parameters

event Event

The general Event to convert to an event of type PenProximityEvent

Returns

PenProximityEvent

Remarks

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

Exceptions

ArgumentException

The Type of the given event was neither PenProximityIn, nor PenProximityOut

implicit operator Event(in PenProximityEvent)

Converts an event of type PenProximityEvent to a general Event

public static implicit operator Event(in PenProximityEvent @event)

Parameters

event PenProximityEvent

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