Mech-DLK SDK (C#) 3.0.0
Mech-DLK SDK (C#) Reference Documentation
 
Loading...
Searching...
No Matches
Mmind::Dl::MMindImage Class Reference

Image class for MechMind DL SDK. More...

#include <MMindImageWrapper.h>

Inheritance diagram for Mmind::Dl::MMindImage:

Public Member Functions

 MMindImage ()
 Constructor.
 
 ~MMindImage ()
 Destructor.
 
 !MMindImage ()
 Finalizer.
 
StatusCode CreateFromPath (String^ imagePath)
 Create image from file path.
 
StatusCode CreateFromRgbData (array< unsigned char >^ rgbData, int width, int height)
 Create image from RGB byte array.
 
StatusCode Save (String^ savePath)
 Save image to file.
 
StatusCode Show (String^ windowName)
 Display image in a window.
 
array< unsigned char > GetData ()
 Get the image data as byte array.
 
mmind::dl::MMindImage * GetNativePtr ()
 Get native pointer (for internal use)
 

Public Attributes

property unsigned int Width
 Get the width of the image.
 
property unsigned int Height
 Get the height of the image.
 
property size_t BytesPerRow
 Get the bytes per row of the image.
 

Detailed Description

Image class for MechMind DL SDK.

Definition at line 14 of file MMindImageWrapper.h.

Constructor & Destructor Documentation

◆ MMindImage()

Mmind::Dl::MMindImage::MMindImage ( )

Constructor.

◆ ~MMindImage()

Mmind::Dl::MMindImage::~MMindImage ( )

Destructor.

◆ !MMindImage()

Mmind::Dl::MMindImage::!MMindImage ( )

Finalizer.

Member Function Documentation

◆ CreateFromPath()

StatusCode Mmind::Dl::MMindImage::CreateFromPath ( String^ imagePath)

Create image from file path.

Parameters
imagePathPath to the image file
Returns
Status code

◆ CreateFromRgbData()

StatusCode Mmind::Dl::MMindImage::CreateFromRgbData ( array< unsigned char >^ rgbData,
int width,
int height )

Create image from RGB byte array.

Parameters
rgbDataRGB image data as byte array
widthImage width
heightImage height
Returns
Status code

◆ GetData()

array< unsigned char > Mmind::Dl::MMindImage::GetData ( )

Get the image data as byte array.

Returns
Byte array containing the image data

◆ GetNativePtr()

mmind::dl::MMindImage * Mmind::Dl::MMindImage::GetNativePtr ( )

Get native pointer (for internal use)

◆ Save()

StatusCode Mmind::Dl::MMindImage::Save ( String^ savePath)

Save image to file.

Parameters
savePathPath to save the image
Returns
Status code

◆ Show()

StatusCode Mmind::Dl::MMindImage::Show ( String^ windowName)

Display image in a window.

Parameters
windowNameName of the window to display the image
Returns
Status code

Member Data Documentation

◆ BytesPerRow

property size_t Mmind::Dl::MMindImage::BytesPerRow
Initial value:
{
size_t get()

Get the bytes per row of the image.

Definition at line 85 of file MMindImageWrapper.h.

◆ Height

property unsigned int Mmind::Dl::MMindImage::Height
Initial value:
{
unsigned int get()

Get the height of the image.

Definition at line 77 of file MMindImageWrapper.h.

◆ Width

property unsigned int Mmind::Dl::MMindImage::Width
Initial value:
{
unsigned int get()

Get the width of the image.

Definition at line 69 of file MMindImageWrapper.h.


The documentation for this class was generated from the following file: