Show / Hide Table of Contents

Interface ISurfaceComponent

Interface for drivers which provide the surface component of the platform abstraction layer.

Inherited Members
IPalComponent.Name
IPalComponent.Provides
IPalComponent.Logger
IPalComponent.Initialize(ToolkitOptions)
Namespace: OpenTK.Core.Platform
Assembly: OpenTK.Core.dll
Syntax
public interface ISurfaceComponent : IPalComponent

Methods

Create()

Create a surface object.

Declaration
SurfaceHandle Create()
Returns
Type Description
SurfaceHandle

A surface object.

Destroy(SurfaceHandle)

Destroy a surface object.

Declaration
void Destroy(SurfaceHandle handle)
Parameters
Type Name Description
SurfaceHandle handle

Handle to a surface.

GetClientSize(SurfaceHandle, out int, out int)

Get the client size of the surface.

Declaration
void GetClientSize(SurfaceHandle handle, out int width, out int height)
Parameters
Type Name Description
SurfaceHandle handle

Handle to a surface.

int width

Width of the surface.

int height

Height of the surface.

GetDisplay(SurfaceHandle)

Get the display the surface is in.

Declaration
DisplayHandle GetDisplay(SurfaceHandle handle)
Parameters
Type Name Description
SurfaceHandle handle

Handle to a surface.

Returns
Type Description
DisplayHandle

Handle to the display the surface is in.

GetType(SurfaceHandle)

Get surface type.

Declaration
SurfaceType GetType(SurfaceHandle handle)
Parameters
Type Name Description
SurfaceHandle handle

Handle to a surface object.

Returns
Type Description
SurfaceType

The surface type.

SetDisplay(SurfaceHandle, DisplayHandle)

Set the display the surface is in.

Declaration
void SetDisplay(SurfaceHandle handle, DisplayHandle display)
Parameters
Type Name Description
SurfaceHandle handle

Handle to a surface.

DisplayHandle display

Handle to the display to set the surface to.

In this article
Back to top Generated by DocFX