Learn how to evaluate and integrate the VNC SDK

We're here if you need help.

PixelFormat

vncsdk.PixelFormat

Description of how pixels are stored in a Viewer framebuffer.

Constructor Summary

Modifier and Type Method and Description

PixelFormat(bitsPerPixel, redMax, greenMax, blueMax, redShift, greenShift, blueShift)

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().
number

blueMax()

Gets the maximum value for the blue pixel value.
number

blueShift()

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

bpp()

Gets the total number of bits per pixel.
number

depth()

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

destroy()

Destroy a custom pixel format.
number

greenMax()

Gets the maximum value for the green pixel value.
number

greenShift()

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

redMax()

Gets the maximum value for the red pixel value.
number

redShift()

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

Constructor

class vncsdk.PixelFormat(bitsPerPixel, redMax, greenMax, blueMax, redShift, greenShift, blueShift)

Creates a custom pixel format based on the given parameters.

For more information, see vnc_PixelFormat_create().

Arguments:
  • bitsPerPixel (number) –
  • redMax (number) –
  • greenMax (number) –
  • blueMax (number) –
  • redShift (number) –
  • greenShift (number) –
  • blueShift (number) –
Throws:

vncsdk.VncException on error

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.blueMax()

Gets the maximum value for the blue pixel value.

For more information, see vnc_PixelFormat_blueMax().

Return type:number
PixelFormat.blueShift()

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

For more information, see vnc_PixelFormat_blueShift().

Return type:number
PixelFormat.bpp()

Gets the total number of bits per pixel.

For more information, see vnc_PixelFormat_bpp().

Return type:number
PixelFormat.depth()

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

For more information, see vnc_PixelFormat_depth().

Return type:number
PixelFormat.destroy()

Destroy a custom pixel format.

For more information, see vnc_PixelFormat_destroy().

PixelFormat.greenMax()

Gets the maximum value for the green pixel value.

For more information, see vnc_PixelFormat_greenMax().

Return type:number
PixelFormat.greenShift()

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

For more information, see vnc_PixelFormat_greenShift().

Return type:number
PixelFormat.redMax()

Gets the maximum value for the red pixel value.

For more information, see vnc_PixelFormat_redMax().

Return type:number
PixelFormat.redShift()

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

For more information, see vnc_PixelFormat_redShift().

Return type:number
×