screen_get_stream_property_iv()
Graphics and Screen4.0 (8.x)Screen Graphics Subsystem Developer's GuideAPIProgrammingUtilities
Retrieve the current value of the specified stream property of type integer
Synopsis:
#include <screen/screen.h>
int screen_get_stream_property_iv(screen_stream_t stream,
int pname,
int *param)
Arguments:
- stream
- The handle of the stream 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 stream property and stores it in a user-provided buffer. The values of the following properties can be queried using this function:
- SCREEN_PROPERTY_ALPHA_MODE
- SCREEN_PROPERTY_BUFFER_COUNT [1]
- SCREEN_PROPERTY_BUFFER_SIZE
- SCREEN_PROPERTY_COLOR_SPACE
- SCREEN_PROPERTY_FORMAT
- SCREEN_PROPERTY_FRONT_BUFFER_COUNT [1]
- SCREEN_PROPERTY_ID [1]
- SCREEN_PROPERTY_METRIC_COUNT [1]
- SCREEN_PROPERTY_MODE
- SCREEN_PROPERTY_OWNER_PID [1]
- SCREEN_PROPERTY_PERMISSIONS
- SCREEN_PROPERTY_PROTECTION_ENABLE
- SCREEN_PROPERTY_RENDER_BUFFER_COUNT [1]
- SCREEN_PROPERTY_SCALE_FACTOR [1]
- SCREEN_PROPERTY_SEQUENCE_ID
- SCREEN_PROPERTY_SOURCE_CLIP_POSITION
- SCREEN_PROPERTY_SOURCE_CLIP_SIZE
- SCREEN_PROPERTY_STATUS
- SCREEN_PROPERTY_SWAP_INTERVAL
- SCREEN_PROPERTY_USAGE
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: