All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events Modules Pages
Loading...
Searching...
No Matches
Image Class Reference

Representation of an image, typically returned by the CameraDevice. More...

Public Member Functions

 Image (ImageDescription description, IntPtr data)
 
void CopyBufferToTexture (Texture2D texture)
 The whole buffer (i.e. BufferWidth x BufferHeight) is copied to the texture. Width, height and format of texture will be updated to fit the input image.
 
void CopyToTexture (Texture2D texture2D)
 Copies the image into the given texture. Width and height of texture will be updated to fit the input image. The image data is converted to the format of the texture. Only grayscale, RGB24 and RGBA32 are supported. Only the image portion defined by Width and Height is copied to the texture, not the whole buffer.
 
void CopyToTexture (Texture2D texture2D, bool flipY)
 Copies the image into the given texture. Width and height of texture will be updated to fit the input image. The image data is converted to the format of the texture. Only grayscale, RGB24 and RGBA32 are supported. Only the image portion defined by Width and Height is copied to the texture, not the whole buffer.
 
void Resize (ImageDescription description)
 Resizing an image deletes any existing image data.
 

Static Public Member Functions

static bool IsNullOrEmpty (Image image)
 Checks whether the image is null or if it's contains any data.
 

Properties

int BufferHeight [get]
 The height (number of rows) of the underlying pixel buffer.
 
int BufferWidth [get]
 The width (number of columns) of the underlying pixel buffer.
 
ImageDescription Description [get]
 
int Height [get]
 The height of the image in pixels. Note that the pixel buffer can be higher than this.
 
IntPtr PixelBufferPtr [get]
 The pointer to the pixel buffer.
 
PixelFormat PixelFormat [get]
 The pixel format of the image.
 
byte[] Pixels [get]
 Get pixel data of the image.
 
int Stride [get]
 The number of bytes between the start of a pixel row and the start of the next.
 
int Width [get]
 The width of the image in pixels. Note that the pixel buffer can be wider than this.
 

Detailed Description

Representation of an image, typically returned by the CameraDevice.

The image's pixel buffer may have a different size than expected based on the values of Width and Height.

Constructor & Destructor Documentation

◆ Image()

Image ( ImageDescription description,
IntPtr data )
inline

Member Function Documentation

◆ CopyBufferToTexture()

void CopyBufferToTexture ( Texture2D texture)
inline

The whole buffer (i.e. BufferWidth x BufferHeight) is copied to the texture. Width, height and format of texture will be updated to fit the input image.

◆ CopyToTexture() [1/2]

void CopyToTexture ( Texture2D texture2D)
inline

Copies the image into the given texture. Width and height of texture will be updated to fit the input image. The image data is converted to the format of the texture. Only grayscale, RGB24 and RGBA32 are supported. Only the image portion defined by Width and Height is copied to the texture, not the whole buffer.

◆ CopyToTexture() [2/2]

void CopyToTexture ( Texture2D texture2D,
bool flipY )
inline

Copies the image into the given texture. Width and height of texture will be updated to fit the input image. The image data is converted to the format of the texture. Only grayscale, RGB24 and RGBA32 are supported. Only the image portion defined by Width and Height is copied to the texture, not the whole buffer.

Parameters
texture2Doutput texture
flipYwhether the image should be flipped in y-direction

◆ IsNullOrEmpty()

static bool IsNullOrEmpty ( Image image)
inlinestatic

Checks whether the image is null or if it's contains any data.

Parameters
image
Returns

◆ Resize()

void Resize ( ImageDescription description)
inline

Resizing an image deletes any existing image data.

Property Documentation

◆ BufferHeight

int BufferHeight
get

The height (number of rows) of the underlying pixel buffer.

◆ BufferWidth

int BufferWidth
get

The width (number of columns) of the underlying pixel buffer.

◆ Description

ImageDescription Description
get

◆ Height

int Height
get

The height of the image in pixels. Note that the pixel buffer can be higher than this.

◆ PixelBufferPtr

IntPtr PixelBufferPtr
get

The pointer to the pixel buffer.

◆ PixelFormat

The pixel format of the image.

◆ Pixels

byte [] Pixels
get

Get pixel data of the image.

◆ Stride

int Stride
get

The number of bytes between the start of a pixel row and the start of the next.

◆ Width

int Width
get

The width of the image in pixels. Note that the pixel buffer can be wider than this.