libzbar-cli : ZBar Namespace

Image Class

Representation of an image in ZBar

public class Image : IDisposable

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: ZBar
Assembly: libzbar-cli (in libzbar-cli.dll)
Assembly Versions: 0.9.3631.24519

Members

See Also: Inherited members from object.

Public Constructors

Image ()
Create/allocate a new uninitialized image
Load image from file in the same format as written by Dump()

Public Properties

Data byte[]. Documentation for this section has not yet been entered.
Format uint . Documentation for this section has not yet been entered.
Height uint . Documentation for this section has not yet been entered.
SequenceNumber uint . Documentation for this section has not yet been entered.
[read-only]
Symbols IEnumerable<Symbol> . Documentation for this section has not yet been entered.
Width uint . Documentation for this section has not yet been entered.

Public Methods

Convert (uint) : Image
Image format conversion. refer to the documentation for supported image formats
Dispose ()
Release resources held by this object
Dump (string)
Dump raw image data to a file for debug.
Finalize ()
Finalize this object

Protected Methods

Dispose (bool)
Dispose this object

Member Details

Image Constructor

Create/allocate a new uninitialized image

public Image ()

Remarks

Be aware that this image is NOT initialized, allocated. And you must set width, height, format, data etc...

Requirements

Namespace: ZBar
Assembly: libzbar-cli (in libzbar-cli.dll)
Assembly Versions: 0.9.3631.24519

Image Constructor

Load image from file in the same format as written by Dump()

public Image (string filename)

Parameters

filename
Path to the file to load the image from

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: ZBar
Assembly: libzbar-cli (in libzbar-cli.dll)
Assembly Versions: 0.9.3631.24519

Convert Method

Image format conversion. refer to the documentation for supported image formats

public Image Convert (uint format)

Parameters

format
FourCC format to convert to.

Returns

A new ZBar.Image with the sample data from the original image converted to the requested format. The original image is unaffected.

Remarks

The converted image size may be rounded (up) due to format constraints

Requirements

Namespace: ZBar
Assembly: libzbar-cli (in libzbar-cli.dll)
Assembly Versions: 0.9.3631.24519

Data Property

Documentation for this section has not yet been entered.

public byte[] Data { set; get; }

Value

Get/set the data associated with this image

Remarks

This method copies that data, using Marshal.Copy.

Requirements

Namespace: ZBar
Assembly: libzbar-cli (in libzbar-cli.dll)
Assembly Versions: 0.9.3631.24519

Dispose Method

Release resources held by this object

public void Dispose ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: ZBar
Assembly: libzbar-cli (in libzbar-cli.dll)
Assembly Versions: 0.9.3631.24519

Dispose Method

Dispose this object

protected virtual void Dispose (bool disposing)

Parameters

disposing
A bool False if called from the finalizer, True if called from Dispose.

Remarks

This boolean disposing parameter here ensures that objects with a finalizer is not disposed, this is method is invoked from the finalizer. Do overwrite, and call, this method in base classes if you use any unmanaged resources.

Requirements

Namespace: ZBar
Assembly: libzbar-cli (in libzbar-cli.dll)
Assembly Versions: 0.9.3631.24519

Dump Method

Dump raw image data to a file for debug.

public void Dump (string filebase)

Parameters

filebase
base filename, appended with ".XXXX.zimg" where XXXX is the format fourcc

Remarks

the data will be prefixed with a 16 byte header consisting of: * 4 bytes uint = 0x676d697a ("zimg") * 4 bytes format fourcc * 2 bytes width * 2 bytes height * 4 bytes size of following image data in bytes

Requirements

Namespace: ZBar
Assembly: libzbar-cli (in libzbar-cli.dll)
Assembly Versions: 0.9.3631.24519

Finalize Method

Finalize this object

void Finalize ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: ZBar
Assembly: libzbar-cli (in libzbar-cli.dll)
Assembly Versions: 0.9.3631.24519

Format Property

Documentation for this section has not yet been entered.

public uint Format { set; get; }

Value

Get/set the fourcc image format code for image sample data.

Remarks

Chaning this doesn't affect the data.

Requirements

Namespace: ZBar
Assembly: libzbar-cli (in libzbar-cli.dll)
Assembly Versions: 0.9.3631.24519

Height Property

Documentation for this section has not yet been entered.

public uint Height { set; get; }

Value

Get/set the height of the image, doesn't affect the data

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: ZBar
Assembly: libzbar-cli (in libzbar-cli.dll)
Assembly Versions: 0.9.3631.24519

SequenceNumber Property

Documentation for this section has not yet been entered.

public uint SequenceNumber { set; get; }

Value

Get/set a "sequence" (page/frame) number associated with this image.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: ZBar
Assembly: libzbar-cli (in libzbar-cli.dll)
Assembly Versions: 0.9.3631.24519

Symbols Property

Documentation for this section has not yet been entered.

public IEnumerable<Symbol> Symbols { get; }

Value

Get ImageScanner decode result iterator.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: ZBar
Assembly: libzbar-cli (in libzbar-cli.dll)
Assembly Versions: 0.9.3631.24519

Width Property

Documentation for this section has not yet been entered.

public uint Width { set; get; }

Value

Get/set the width of the image, doesn't affect the data

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: ZBar
Assembly: libzbar-cli (in libzbar-cli.dll)
Assembly Versions: 0.9.3631.24519