PixelFormat
PixelFormat class
Operations
- GetAmask
- GetBitsPerPixel
- GetBmask
- GetBytesPerPixel
- GetFormat
- GetGmask
- GetRmask
- MapRGB
- MapRGBA
- SetAmask
- SetBitsPerPixel
- SetBmask
- SetBytesPerPixel
- SetFormat
- SetGmask
- SetRmask
GetAmask
Get mask representing the location of the alpha component of the pixel or 0 if the pixel format doesn't have any alpha information
method : public : GetAmask() ~ IntReturn
| Type | Description |
|---|---|
| Int | pixel mask |
GetBitsPerPixel
Get the number of significant bits in a pixel value
method : public : GetBitsPerPixel() ~ IntReturn
| Type | Description |
|---|---|
| Int | bits per pixel |
GetBmask
Get mask representing the location of the blue component of the pixel
method : public : GetBmask() ~ IntReturn
| Type | Description |
|---|---|
| Int | pixel mask |
GetBytesPerPixel
Get the number of bytes required to hold a pixel value
method : public : GetBytesPerPixel() ~ IntReturn
| Type | Description |
|---|---|
| Int | bytes per pixel |
GetFormat
Get pixel format
method : public : GetFormat() ~ PixelValueReturn
| Type | Description |
|---|---|
| PixelValue | pixel format |
GetGmask
Get mask representing the location of the green component of the pixel
method : public : GetGmask() ~ IntReturn
| Type | Description |
|---|---|
| Int | pixel mask |
GetRmask
Get mask representing the location of the red component of the pixel
method : public : GetRmask() ~ IntReturn
| Type | Description |
|---|---|
| Int | pixel mask |
MapRGB
Map an RGB triple to an opaque pixel value for a given pixel format
method : public : MapRGB(r:Int, g:Int, b:Int) ~ IntParameters
| Name | Type | Description |
|---|---|---|
| r | Int | the red component of the pixel in the range 0-255 |
| g | Int | the green component of the pixel in the range 0-255 |
| b | Int | the blue component of the pixel in the range 0-255 |
Return
| Type | Description |
|---|---|
| Int | returns a pixel value |
MapRGBA
Map an RGBA quadruple to a pixel value for a given pixel format
method : public : MapRGBA(r:Int, g:Int, b:Int, a:Int) ~ IntParameters
| Name | Type | Description |
|---|---|---|
| r | Int | the red component of the pixel in the range 0-255 |
| g | Int | the green component of the pixel in the range 0-255 |
| b | Int | the blue component of the pixel in the range 0-255 |
| a | Int | the alpha component of the pixel in the range 0-255 |
Return
| Type | Description |
|---|---|
| Int | returns a pixel value |
SetAmask
Set alpha mask
method : public : SetAmask(a_mask:Int) ~ NilParameters
| Name | Type | Description |
|---|---|---|
| a_mask | Int | alpha mask |
SetBitsPerPixel
Set bits per pixel
method : public : SetBitsPerPixel(bits_per_pixel:Int) ~ NilParameters
| Name | Type | Description |
|---|---|---|
| bits_per_pixel | Int | bits per pixel |
SetBmask
Set blue mask
method : public : SetBmask(b_mask:Int) ~ NilParameters
| Name | Type | Description |
|---|---|---|
| b_mask | Int | blue mask |
SetBytesPerPixel
Set bytes per pixel
method : public : SetBytesPerPixel(bytes_per_pixel:Int) ~ NilParameters
| Name | Type | Description |
|---|---|---|
| bytes_per_pixel | Int | bytes per pixel |
SetFormat
Set pixel format
method : public : SetFormat(format:Int) ~ NilParameters
| Name | Type | Description |
|---|---|---|
| format | Int | pixel format |
SetGmask
Set green mask
method : public : SetGmask(g_mask:Int) ~ NilParameters
| Name | Type | Description |
|---|---|---|
| g_mask | Int | green mask |
SetRmask
Set red mask
method : public : SetRmask(r_mask:Int) ~ NilParameters
| Name | Type | Description |
|---|---|---|
| r_mask | Int | red mask |