Learn how to evaluate and integrate the VNC SDK

We're here if you need help.

PixelFormat

class vncsdk.PixelFormat

Description of how pixels are stored in a Viewer framebuffer.

Constructor Summary

Modifier and Type Method and Description

__init__(bits_per_pixel, red_max, green_max, blue_max, red_shift, green_shift, blue_shift)

Creates a custom pixel format based on the given parameters.

Method Summary

Modifier and Type Method and Description
vncsdk.PixelFormat

bgr888()

32 bits per pixel stored as XXXXXXXXBBBBBBBBGGGGGGGGRRRRRRRR in most significant to least significant bit order For more information, see vnc_PixelFormat_bgr888().
vncsdk.PixelFormat

rgb555()

16 bits per pixel stored as XRRRRRGGGGGBBBBB in most significant to least significant bit order For more information, see vnc_PixelFormat_rgb555().
vncsdk.PixelFormat

rgb565()

16 bits per pixel stored as RRRRRGGGGGGBBBBB in most significant to least significant bit order For more information, see vnc_PixelFormat_rgb565().
vncsdk.PixelFormat

rgb888()

32 bits per pixel stored as XXXXXXXXRRRRRRRRGGGGGGGGBBBBBBBB in most significant to least significant bit order For more information, see vnc_PixelFormat_rgb888().
int

blue_max()

Gets the maximum value for the blue pixel value.
int

blue_shift()

Gets the number of bits the blue pixel value is shifted.
int

bpp()

Gets the total number of bits per pixel.
int

depth()

Gets the number of significant bits that are used to store pixel data.

destroy()

Destroy a custom pixel format.
int

green_max()

Gets the maximum value for the green pixel value.
int

green_shift()

Gets the number of bits the green pixel value is shifted.
int

red_max()

Gets the maximum value for the red pixel value.
int

red_shift()

Gets the number of bits the red pixel value is shifted.

Constructor

vncsdk.PixelFormat.__init__(bits_per_pixel, red_max, green_max, blue_max, red_shift, green_shift, blue_shift)

Creates a custom pixel format based on the given parameters.

For more information, see vnc_PixelFormat_create().

Parameters:
  • bits_per_pixel (int) –
  • red_max (int) –
  • green_max (int) –
  • blue_max (int) –
  • red_shift (int) –
  • green_shift (int) –
  • blue_shift (int) –

Static methods

vncsdk.PixelFormat.bgr888()

32 bits per pixel stored as XXXXXXXXBBBBBBBBGGGGGGGGRRRRRRRR in most significant to least significant bit order

For more information, see vnc_PixelFormat_bgr888().

Return type:vncsdk.PixelFormat
vncsdk.PixelFormat.rgb555()

16 bits per pixel stored as XRRRRRGGGGGBBBBB in most significant to least significant bit order

For more information, see vnc_PixelFormat_rgb555().

Return type:vncsdk.PixelFormat
vncsdk.PixelFormat.rgb565()

16 bits per pixel stored as RRRRRGGGGGGBBBBB in most significant to least significant bit order

For more information, see vnc_PixelFormat_rgb565().

Return type:vncsdk.PixelFormat
vncsdk.PixelFormat.rgb888()

32 bits per pixel stored as XXXXXXXXRRRRRRRRGGGGGGGGBBBBBBBB in most significant to least significant bit order

For more information, see vnc_PixelFormat_rgb888().

Return type:vncsdk.PixelFormat

Methods

PixelFormat.blue_max()

Gets the maximum value for the blue pixel value.

For more information, see vnc_PixelFormat_blueMax().

Return type:int
PixelFormat.blue_shift()

Gets the number of bits the blue pixel value is shifted.

For more information, see vnc_PixelFormat_blueShift().

Return type:int
PixelFormat.bpp()

Gets the total number of bits per pixel.

For more information, see vnc_PixelFormat_bpp().

Return type:int
PixelFormat.depth()

Gets the number of significant bits that are used to store pixel data.

For more information, see vnc_PixelFormat_depth().

Return type:int
PixelFormat.destroy()

Destroy a custom pixel format.

For more information, see vnc_PixelFormat_destroy().

PixelFormat.green_max()

Gets the maximum value for the green pixel value.

For more information, see vnc_PixelFormat_greenMax().

Return type:int
PixelFormat.green_shift()

Gets the number of bits the green pixel value is shifted.

For more information, see vnc_PixelFormat_greenShift().

Return type:int
PixelFormat.red_max()

Gets the maximum value for the red pixel value.

For more information, see vnc_PixelFormat_redMax().

Return type:int
PixelFormat.red_shift()

Gets the number of bits the red pixel value is shifted.

For more information, see vnc_PixelFormat_redShift().

Return type:int
×