INativeWindow

Description

interface Tinman.Engine.Application.INativeWindow

Derived from

INativeHandle
INativeWindowRecreate

Extended by

IApplicationWindow
NativeWindow sealed

Base interface for classes that wrap a native window.

Public / Methods

Native​Handle​As

public method NativeHandleAs → (1)

type in : NativeHandleFlags

The native handle type that the caller understands.

returns → IntPtr

The native handle of the given type in or IntPtr.Zero if the requested type is not available.

Returns the native handle of the given type.

Some native handle types like NativeHandleFlags.Type_SDL3 represent an abstraction which in turn wraps another native handle. With this method, the underlying native handle type may be queried.

Public / Attributes

Client​Size

public attribute ClientSize → (get)

value : Vec2I

The size of the window client area.

The current size of the application window client area.

Native​Handle​Type

public attribute NativeHandleType → (get)

value : NativeHandleFlags

The native handle flags, which will include zero or one type flags (see NativeHandleFlags.Type) and zero or more feature flags (see NativeHandleFlags.Feature). If there is no type flag, the native handle will always be IntPtr.Zero.

Returns the native handle type of this window.

The handle type depicts how to interpret INativeHandle.NativeHandle. Use NativeHandleAs to obtain the handle value for a specific handle type, which may be possible if the type is an abstraction and aggregates a native handle.

Extensions

Native​Handle​Types

public static method NativeHandleTypes → ()

returns → NativeHandleFlags

The supported handle types, which include INativeWindow.NativeHandleType as well as those type flags for which INativeWindow.NativeHandleAs returns a non-zero handle.

Returns all native handle types that this window supports.