screen_get_window_property_iv()
Graphics and Screen4.0 (8.x)Screen Graphics Subsystem Developer's GuideAPIProgrammingUtilities
Retrieve the current value of the specified window property of type integer
Synopsis:
#include <screen/screen.h>
int screen_get_window_property_iv(screen_window_t win,
int pname,
int *param)
Arguments:
- win
- The handle of the window whose property is being queried.
- pname
- The name of the property whose value is being queried. The properties available for querying are of type Screen property types.
- param
- A pointer to a buffer where this function stores the retrieved value(s). This buffer must be of type
int
. The buffer may be a single integer or an array of integers, depending on the property being retrieved.
Library:
libscreenDescription:
Function Type: Flushing Execution
This function retrieves the value of a window property and stores them in a user-provided buffer. The values of the following properties can be queried using this function:
- SCREEN_PROPERTY_ALPHA_MODE
- SCREEN_PROPERTY_BRIGHTNESS
- SCREEN_PROPERTY_BUFFER_COUNT [1]
- SCREEN_PROPERTY_BUFFER_SIZE
- SCREEN_PROPERTY_CBABC_MODE
- SCREEN_PROPERTY_CLIP_POSITION
- SCREEN_PROPERTY_CLIP_SIZE
- SCREEN_PROPERTY_COLOR
- SCREEN_PROPERTY_COLOR_SPACE
- SCREEN_PROPERTY_CONTRAST
- SCREEN_PROPERTY_DEBUG
- SCREEN_PROPERTY_FLIP
- SCREEN_PROPERTY_FLOATING
- SCREEN_PROPERTY_FOCUS
- SCREEN_PROPERTY_FORMAT
- SCREEN_PROPERTY_GLOBAL_ALPHA
- SCREEN_PROPERTY_HUE
- SCREEN_PROPERTY_ID [1]
- SCREEN_PROPERTY_IDLE_MODE
- SCREEN_PROPERTY_METRIC_COUNT [1]
- SCREEN_PROPERTY_MIRROR
- SCREEN_PROPERTY_OWNER_PID [1]
- SCREEN_PROPERTY_PERMISSIONS
- SCREEN_PROPERTY_PIPELINE
- SCREEN_PROPERTY_POSITION
- SCREEN_PROPERTY_PROTECTION_ENABLE
- SCREEN_PROPERTY_RENDER_BUFFER_COUNT [1]
- SCREEN_PROPERTY_ROTATION
- SCREEN_PROPERTY_SATURATION
- SCREEN_PROPERTY_SCALE_FACTOR [1]
- SCREEN_PROPERTY_SCALE_QUALITY
- SCREEN_PROPERTY_SELF_LAYOUT
- SCREEN_PROPERTY_SENSITIVITY
- SCREEN_PROPERTY_SENSITIVITY_THRESHOLD
- SCREEN_PROPERTY_SEQUENCE_ID
- SCREEN_PROPERTY_SIZE
- SCREEN_PROPERTY_SOURCE_CLIP_POSITION
- SCREEN_PROPERTY_SOURCE_CLIP_SIZE
- SCREEN_PROPERTY_SOURCE_POSITION
- SCREEN_PROPERTY_SOURCE_SIZE
- SCREEN_PROPERTY_STATIC
- SCREEN_PROPERTY_STATUS
- SCREEN_PROPERTY_SWAP_INTERVAL
- SCREEN_PROPERTY_TRANSFORM
- SCREEN_PROPERTY_TRANSPARENCY
- SCREEN_PROPERTY_TYPE
- SCREEN_PROPERTY_USAGE
- SCREEN_PROPERTY_VIEWPORT_POSITION
- SCREEN_PROPERTY_VIEWPORT_SIZE
- SCREEN_PROPERTY_VISIBLE
- SCREEN_PROPERTY_ZORDER
Note [1]: When retrieving this property, the function type is Immediate Execution.
Returns:
0
if successful, or -1
if an error occurred (errno
is set; refer to errno.h
for more details).
Page updated: