Screen status types

The types of status for Screen API objects

Synopsis:

#include <screen/screen.h>
enum {
    SCREEN_STATUS_ENOTSUP = -48,
    SCREEN_STATUS_EACCES = -13,
    SCREEN_STATUS_EAGAIN = -11,
    SCREEN_STATUS_DESTROYED = 0,
    SCREEN_STATUS_CREATED = 1,
    SCREEN_STATUS_REALIZED = 2,
    SCREEN_STATUS_INVISIBLE = 3,
    SCREEN_STATUS_CLIPPED = 4,
    SCREEN_STATUS_COVERED = 5,
    SCREEN_STATUS_VISIBLE = 9,
    SCREEN_STATUS_FULLY_VISIBLE = 10,
    SCREEN_STATUS_FULLSCREEN = 11
};

Data:

SCREEN_STATUS_ENOTSUP
The Screen API object isn't supported.
Applicable to the following Screen API object(s):
  • window (e.g., possibly there's no framebuffer available)
SCREEN_STATUS_EACCES
The Screen API object isn't accessible due to permissions.
Applicable to the following Screen API object(s):
  • window
SCREEN_STATUS_EAGAIN
The Screen API object is unavailable.
Applicable to the following Screen API object(s):
  • window
SCREEN_STATUS_DESTROYED
The Screen API object is destroyed.
Applicable to the following Screen API object(s):
  • context
  • device
  • group
  • pixmap
  • session
  • stream
  • window
SCREEN_STATUS_CREATED
The Screen API object is created.
In some cases, the Screen API object is created, but has no buffers. Applicable to the following Screen API object(s):
  • context
  • device
  • group
  • pixmap
  • session
  • stream
  • window
SCREEN_STATUS_REALIZED
The Screen API object is created.
In some cases, the Screen API object is created and has at least one buffer. Applicable to the following Screen API object(s):
  • pixmap
  • stream
  • window
SCREEN_STATUS_INVISIBLE
The Screen API object isn't visible.
Applicable to the following Screen API object(s):
  • stream
  • window
SCREEN_STATUS_CLIPPED
The Screen API object is clipped by the framebuffer; therefore, it's not shown on the display.
Applicable to the following Screen API object(s):
  • window
SCREEN_STATUS_COVERED
The Screen API object is covered; therefore, it may not be shown on the display.
Applicable to the following Screen API object(s):
  • window
SCREEN_STATUS_VISIBLE
The Screen API object is visible.
Applicable to the following Screen API object(s):
  • window (visible, but isn't necessarily shown on the display)
SCREEN_STATUS_FULLY_VISIBLE
The Screen API object is visible, and is shown on the display.
Applicable to the following Screen API object(s):
  • window
SCREEN_STATUS_FULLSCREEN
The Screen API object is the same size as the display.
Applicable to the following Screen API object(s):
  • window

Library:

libscreen

Description:

Not all status types are applicable to all Screen API objects.