Deprecated API

Typedefs
typedef PuglCreateEvent	PuglEventCreate
typedef PuglDestroyEvent	PuglEventDestroy
typedef PuglConfigureEvent	PuglEventConfigure
typedef PuglMapEvent	PuglEventMap
typedef PuglUnmapEvent	PuglEventUnmap
typedef PuglUpdateEvent	PuglEventUpdate
typedef PuglExposeEvent	PuglEventExpose
typedef PuglCloseEvent	PuglEventClose
typedef PuglFocusEvent	PuglEventFocus
typedef PuglKeyEvent	PuglEventKey
typedef PuglTextEvent	PuglEventText
typedef PuglCrossingEvent	PuglEventCrossing
typedef PuglButtonEvent	PuglEventButton
typedef PuglMotionEvent	PuglEventMotion
typedef PuglScrollEvent	PuglEventScroll
typedef PuglClientEvent	PuglEventClient
typedef PuglTimerEvent	PuglEventTimer
typedef PuglLoopEnterEvent	PuglEventLoopEnter
typedef PuglLoopLeaveEvent	PuglEventLoopLeave
typedef uintptr_t	PuglNativeWindow

Functions
static	PUGL_DEPRECATED_BY ("puglNewView") PuglView *puglInit(const int *pargc
return	puglNewView (puglNewWorld(PUGL_MODULE, 0))
static	PUGL_DEPRECATED_BY ("puglFreeView") void puglDestroy(PuglView *view)
static	PUGL_DEPRECATED_BY ("puglSetClassName") void puglInitWindowClass(PuglView *view
static	PUGL_DEPRECATED_BY ("puglSetFrame") void puglInitWindowSize(PuglView *view
	puglSetFrame (view, frame)
static	PUGL_DEPRECATED_BY ("puglSetMinSize") void puglInitWindowMinSize(PuglView *view
static	PUGL_DEPRECATED_BY ("puglSetAspectRatio") void puglInitWindowAspectRatio(PuglView *view
	puglSetSizeHint (view, PUGL_MAX_ASPECT,(PuglSpan) maxX,(PuglSpan) maxY)
static	PUGL_DEPRECATED_BY ("puglSetTransientParent") void puglInitTransientFor(PuglView *view
static	PUGL_DEPRECATED_BY ("puglSetViewHint") void puglInitResizable(PuglView *view
static	PUGL_DEPRECATED_BY ("puglGetFrame") void puglGetSize(PuglView *view
static	PUGL_DEPRECATED_BY ("puglSetParentWindow") void puglInitWindowParent(PuglView *view
static	PUGL_DEPRECATED_BY ("puglSetBackend") int puglInitBackend(PuglView *view
static	PUGL_DEPRECATED_BY ("puglRealize") PuglStatus puglCreateWindow(PuglView *view
return	puglRealize (view)
PUGL_API PuglStatus	puglWaitForEvent (PuglView *view)
PUGL_API PuglStatus	puglProcessEvents (PuglView *view)
static	PUGL_DEPRECATED_BY ("puglUpdate") PuglStatus puglPollEvents(PuglWorld *world
static	PUGL_DEPRECATED_BY ("puglShow") PuglStatus puglShowWindow(PuglView *view)
static	PUGL_DEPRECATED_BY ("puglHide") PuglStatus puglHideWindow(PuglView *view)
static	PUGL_DEPRECATED_BY ("puglSetSizeHint") PuglStatus puglSetDefaultSize(PuglView *view
static	PUGL_DEPRECATED_BY ("puglGetNativeView") PuglNativeView puglGetNativeWindow(PuglView *view)
	Return the native window handle.

Variables
static char **	argv
static const char *	name
static int	width = (PuglSpan)width
static int int	height
static int	minX
static int int	minY
static int int int	maxX
static int int int int	maxY
static uintptr_t	parent
static bool	resizable
static bool	ignore
static PuglViewHint	hint
static PuglViewHint int	value
static const PuglBackend *	backend
static const char *	title
static double	timeout
const PuglStatus	st1
return st0	st0
char *	argv []

Detailed Description

Typedef Documentation

PuglEventButton

typedef PuglButtonEvent PuglEventButton

PuglEventClient

typedef PuglClientEvent PuglEventClient

PuglEventClose

typedef PuglCloseEvent PuglEventClose

PuglEventConfigure

typedef PuglConfigureEvent PuglEventConfigure

PuglEventCreate

typedef PuglCreateEvent PuglEventCreate

PuglEventCrossing

typedef PuglCrossingEvent PuglEventCrossing

PuglEventDestroy

typedef PuglDestroyEvent PuglEventDestroy

PuglEventExpose

typedef PuglExposeEvent PuglEventExpose

PuglEventFocus

typedef PuglFocusEvent PuglEventFocus

PuglEventKey

typedef PuglKeyEvent PuglEventKey

PuglEventLoopEnter

typedef PuglLoopEnterEvent PuglEventLoopEnter

PuglEventLoopLeave

typedef PuglLoopLeaveEvent PuglEventLoopLeave

PuglEventMap

typedef PuglMapEvent PuglEventMap

PuglEventMotion

typedef PuglMotionEvent PuglEventMotion

PuglEventScroll

typedef PuglScrollEvent PuglEventScroll

PuglEventText

typedef PuglTextEvent PuglEventText

PuglEventTimer

typedef PuglTimerEvent PuglEventTimer

PuglEventUnmap

typedef PuglUnmapEvent PuglEventUnmap

PuglEventUpdate

typedef PuglUpdateEvent PuglEventUpdate

PuglNativeWindow

typedef uintptr_t PuglNativeWindow

A native window handle.

X11: This is a Window.

MacOS: This is a pointer to an NSView*.

Windows: This is a HWND.

Function Documentation

PUGL_DEPRECATED_BY() [1/17]

PUGL_DEPRECATED_BY ( "puglFreeView" )

inlinestatic

Destroy an app and view created with puglInit().

Deprecated

Use puglFreeApp() and puglFreeView().

PUGL_DEPRECATED_BY() [2/17]

PUGL_DEPRECATED_BY ( "puglGetFrame" )

inlinestatic

Get the current size of the view.

Deprecated

Use puglGetFrame().

PUGL_DEPRECATED_BY() [3/17]

PUGL_DEPRECATED_BY ( "puglGetNativeView" )

inlinestatic

Return the native window handle.

PUGL_DEPRECATED_BY() [4/17]

PUGL_DEPRECATED_BY ( "puglHide" )

inlinestatic

PUGL_DEPRECATED_BY() [5/17]

PUGL_DEPRECATED_BY ( "puglNewView" ) const

inlinestatic

Create a Pugl application and view.

To create a window, call the various puglInit* functions as necessary, then call puglRealize().

Deprecated

Use puglNewApp() and puglNewView().

Parameters

pargc	Pointer to argument count (currently unused).
argv	Arguments (currently unused).

Returns

A newly created view.

PUGL_DEPRECATED_BY() [6/17]

PUGL_DEPRECATED_BY ( "puglRealize" )

inlinestatic

Realize a view by creating a corresponding system view or window.

The view should be fully configured using the above functions before this is called. This function may only be called once per view.

Deprecated

Use puglRealize(), or just show the view.

PUGL_DEPRECATED_BY() [7/17]

PUGL_DEPRECATED_BY ( "puglSetAspectRatio" )

inlinestatic

Set the window aspect ratio range before creating a window.

The x and y values here represent a ratio of width to height. To set a fixed aspect ratio, set the minimum and maximum values to the same ratio.

Note that setting different minimum and maximum constraints does not currently work on MacOS (the minimum is used), so only setting a fixed aspect ratio works properly across all platforms.

PUGL_DEPRECATED_BY() [8/17]

PUGL_DEPRECATED_BY ( "puglSetBackend" )

inlinestatic

Set the graphics backend to use.

Deprecated

Use puglSetBackend().

PUGL_DEPRECATED_BY() [9/17]

PUGL_DEPRECATED_BY ( "puglSetClassName" )

inlinestatic

Set the window class name before creating a window.

PUGL_DEPRECATED_BY() [10/17]

PUGL_DEPRECATED_BY ( "puglSetFrame" )

inlinestatic

Set the window size before creating a window.

Deprecated

Use puglSetFrame().

PUGL_DEPRECATED_BY() [11/17]

PUGL_DEPRECATED_BY ( "puglSetMinSize" )

inlinestatic

Set the minimum window size before creating a window.

PUGL_DEPRECATED_BY() [12/17]

PUGL_DEPRECATED_BY ( "puglSetParentWindow" )

inlinestatic

Set the parent window before creating a window (for embedding).

Deprecated

Use puglSetWindowParent().

PUGL_DEPRECATED_BY() [13/17]

PUGL_DEPRECATED_BY ( "puglSetSizeHint" )

inlinestatic

Set the default size of the view.

This should be called before puglRealize() to set the default size of the view, which will be the initial size of the window if this is a top level view.

Returns

PUGL_UNKNOWN_ERROR on failure, but always succeeds if the view is not yet realized.

Set the minimum size of the view.

If an initial minimum size is known, this should be called before puglRealize() to avoid stutter, though it can be called afterwards as well.

Returns

PUGL_UNKNOWN_ERROR on failure, but always succeeds if the view is not yet realized.

Set the maximum size of the view.

If an initial maximum size is known, this should be called before puglRealize() to avoid stutter, though it can be called afterwards as well.

Returns

PUGL_UNKNOWN_ERROR on failure, but always succeeds if the view is not yet realized.

Set the view aspect ratio range.

The x and y values here represent a ratio of width to height. To set a fixed aspect ratio, set the minimum and maximum values to the same ratio.

Note that setting different minimum and maximum constraints does not currently work on MacOS (the minimum is used), so only setting a fixed aspect ratio works properly across all platforms.

If an initial aspect ratio is known, this should be called before puglRealize() to avoid stutter, though it can be called afterwards as well.

Returns

PUGL_UNKNOWN_ERROR on failure, but always succeeds if the view is not yet realized.

PUGL_DEPRECATED_BY() [14/17]

PUGL_DEPRECATED_BY ( "puglSetTransientParent" )

inlinestatic

Set transient parent before creating a window.

On X11, parent must be a Window. On OSX, parent must be an NSView*.

Set transient parent before creating a window.

Deprecated

Use puglSetTransientParent().

PUGL_DEPRECATED_BY() [15/17]

PUGL_DEPRECATED_BY ( "puglSetViewHint" )

inlinestatic

Enable or disable resizing before creating a window.

Deprecated

Use puglSetViewHint() with PUGL_RESIZABLE.

Ignore synthetic repeated key events.

Deprecated

Use puglSetViewHint() with PUGL_IGNORE_KEY_REPEAT.

Set a hint before creating a window.

Deprecated

Use puglSetWindowHint().

PUGL_DEPRECATED_BY() [16/17]

PUGL_DEPRECATED_BY ( "puglShow" )

inlinestatic

PUGL_DEPRECATED_BY() [17/17]

PUGL_DEPRECATED_BY ( "puglUpdate" )

inlinestatic

Poll for events that are ready to be processed.

This polls for events that are ready for any view in the world, potentially blocking depending on timeout.

Parameters

world	The world to poll for events.
timeout	Maximum time to wait, in seconds. If zero, the call returns immediately, if negative, the call blocks indefinitely.

Returns

PUGL_SUCCESS if events are read, PUGL_FAILURE if not, or an error.

Deprecated

Use puglUpdate().

Dispatch any pending events to views.

This processes all pending events, dispatching them to the appropriate views. View event handlers will be called in the scope of this call. This function does not block, if no events are pending then it will return immediately.

Deprecated

Use puglUpdate().

puglNewView()

return puglNewView

(

puglNewWorld(PUGL_MODULE, 0)

)

puglProcessEvents()

PUGL_API PuglStatus puglProcessEvents

(

PuglView *

view

)

Process all pending window events.

This handles input events as well as rendering, so it should be called regularly and rapidly enough to keep the UI responsive. This function does not block if no events are pending.

Deprecated

Use puglDispatchEvents().

puglRealize()

return puglRealize

(

view

)

puglSetFrame()

puglSetFrame	(	view	,
		frame	)

puglSetSizeHint()

puglSetSizeHint	(	view	,
		PUGL_MAX_ASPECT	,
		(PuglSpan)	maxX,
		(PuglSpan)	maxY )

puglWaitForEvent()

PUGL_API PuglStatus puglWaitForEvent

(

PuglView *

view

)

Block and wait for an event to be ready.

This can be used in a loop to only process events via puglProcessEvents when necessary. This function will block indefinitely if no events are available, so is not appropriate for use in programs that need to perform regular updates (e.g. animation).

Deprecated

Use puglPollEvents().

Variable Documentation

argv [1/2]

void argv

argv [2/2]

void argv

Initial value:

{
  (void)pargc

backend

const PuglBackend* backend

Initial value:

{
  return (int)puglSetBackend(view, backend)

height

int int height

Initial value:

{
  PuglRect frame = puglGetFrame(view)

hint

PuglViewHint hint

ignore

bool ignore

Initial value:

{
  puglSetViewHint(view, PUGL_IGNORE_KEY_REPEAT, ignore)

maxX

int int int maxX

maxY

int int int int maxY

Initial value:

{
  puglSetSizeHint(view, PUGL_MIN_ASPECT, (PuglSpan)minX, (PuglSpan)minY)

minX

int minX

minY

int int minY

name

const char* name

Initial value:

{
  puglSetClassName(puglGetWorld(view), name)

parent

PuglNativeWindow parent

Initial value:

{
  puglSetTransientParent(view, (PuglNativeWindow)parent)

resizable

bool resizable

Initial value:

{
  puglSetViewHint(view, PUGL_RESIZABLE, resizable)

st0

return st0 st0

st1

const PuglStatus st1

Initial value:

                   =
puglSetSizeHint(view, PUGL_MAX_ASPECT, (PuglSpan)maxX, (PuglSpan)maxY)

timeout

double timeout

Initial value:

{
  return puglUpdate(world, timeout)

title

const char* title

Initial value:

{
  puglSetWindowTitle(view, title)

value

PuglViewHint int value

Initial value:

{
  puglSetViewHint(view, hint, value)

width

png_const_structrp png_inforp int png_fixed_point width = (PuglSpan)width