imgSessionClearBuffer
- Updated2023-02-21
- 1 minute(s) read
imgSessionClearBuffer
Format
rval = imgSessionClearBuffer(SESSION_ID sid, uInt32 buf_num, uInt8 pixel_value)
Purpose
Sets buffer image data to the specified pixel value.
Parameters
| Name | Type | Direction | Description |
| sid | SESSION_ID | input | Session ID |
| buf_num | uInt32 | input | Element number of the buffer to clear |
| pixel_value | uInt8 | input | Pixel value to set data to |
| rval | Int32 | output | Status |
Parameter Discussion
sid is a valid SESSION_ID variable.
buf_num indicates a valid buffer list element number.
pixel_value indicates a pixel value to set all the buffer data with.
Return Value
rval returns 0 on success. On failure, this function returns an error code. For information about the error code, call imgShowError.