Show / Hide Table of Contents

Class jpeg_common_struct

Base class for both JPEG compressor and decompresor.

Inheritance
System.Object
jpeg_common_struct
jpeg_compress_struct
jpeg_decompress_struct
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: BitMiracle.LibJpeg.Classic
Assembly: BitMiracle.LibJpeg.NET.dll
Syntax
public abstract class jpeg_common_struct
Remarks

Routines that are to be used by both halves of the library are declared to receive an instance of this class. There are no actual instances of jpeg_common_struct, only of jpeg_compress_struct and jpeg_decompress_struct

Constructors

| Improve this Doc View Source

jpeg_common_struct()

Base constructor.

Declaration
protected jpeg_common_struct()
See Also
jpeg_compress_struct
jpeg_decompress_struct
| Improve this Doc View Source

jpeg_common_struct(jpeg_error_mgr)

Base constructor.

Declaration
protected jpeg_common_struct(jpeg_error_mgr errorManager)
Parameters
Type Name Description
jpeg_error_mgr errorManager

The error manager.

See Also
jpeg_compress_struct
jpeg_decompress_struct

Properties

| Improve this Doc View Source

Copyright

Gets the LibJpeg's copyright.

Declaration
public static string Copyright { get; }
Property Value
Type Description
System.String

The copyright.

| Improve this Doc View Source

Err

Error handler module.

Declaration
public jpeg_error_mgr Err { get; set; }
Property Value
Type Description
jpeg_error_mgr

The error manager.

See Also
Error handling
| Improve this Doc View Source

IsDecompressor

Gets a value indicating whether this instance is Jpeg decompressor.

Declaration
public abstract bool IsDecompressor { get; }
Property Value
Type Description
System.Boolean

true if this is Jpeg decompressor; otherwise, false.

| Improve this Doc View Source

Progress

Progress monitor.

Declaration
public jpeg_progress_mgr Progress { get; set; }
Property Value
Type Description
jpeg_progress_mgr

The progress manager.

Remarks

Default value: null.

| Improve this Doc View Source

Version

Gets the version of LibJpeg.

Declaration
public static string Version { get; }
Property Value
Type Description
System.String

The version of LibJpeg.

Methods

| Improve this Doc View Source

AllocJpegSamples(Int32, Int32)

Creates 2-D sample array.

Declaration
public static byte[][] AllocJpegSamples(int samplesPerRow, int numberOfRows)
Parameters
Type Name Description
System.Int32 samplesPerRow

The number of samples per row.

System.Int32 numberOfRows

The number of rows.

Returns
Type Description
System.Byte[][]

The array of samples.

| Improve this Doc View Source

CreateBlocksArray(Int32, Int32)

Creates the array of blocks.

Declaration
public static jvirt_array<JBLOCK> CreateBlocksArray(int blocksPerRow, int numberOfRows)
Parameters
Type Name Description
System.Int32 blocksPerRow

The number of blocks in row.

System.Int32 numberOfRows

The number of rows.

Returns
Type Description
jvirt_array<JBLOCK>

The array of blocks.

See Also
JBLOCK
| Improve this Doc View Source

CreateSamplesArray(Int32, Int32)

Creates the array of samples.

Declaration
public static jvirt_array<byte> CreateSamplesArray(int samplesPerRow, int numberOfRows)
Parameters
Type Name Description
System.Int32 samplesPerRow

The number of samples in row.

System.Int32 numberOfRows

The number of rows.

Returns
Type Description
jvirt_array<System.Byte>

The array of samples.

| Improve this Doc View Source

ERREXIT(J_MESSAGE_CODE)

Used for fatal errors (print message and exit).

Declaration
public void ERREXIT(J_MESSAGE_CODE code)
Parameters
Type Name Description
J_MESSAGE_CODE code

The message code.

| Improve this Doc View Source

ERREXIT(J_MESSAGE_CODE, Object[])

Used for fatal errors (print message and exit).

Declaration
public void ERREXIT(J_MESSAGE_CODE code, params object[] args)
Parameters
Type Name Description
J_MESSAGE_CODE code

The message code.

System.Object[] args

The parameters of message.

| Improve this Doc View Source

ERREXIT(Int32, Object[])

Used for fatal errors (print message and exit).

Declaration
public void ERREXIT(int code, params object[] args)
Parameters
Type Name Description
System.Int32 code

The message code.

System.Object[] args

The parameters of message.

| Improve this Doc View Source

jpeg_abort()

Abort processing of a JPEG compression or decompression operation, but don't destroy the object itself.

Closing a data source or destination, if necessary, is the application's responsibility.

Declaration
public void jpeg_abort()
| Improve this Doc View Source

jpeg_destroy()

Destruction of a JPEG object.

Closing a data source or destination, if necessary, is the application's responsibility.

Declaration
public void jpeg_destroy()
| Improve this Doc View Source

TRACEMS(Int32, J_MESSAGE_CODE)

Shows informational and debugging messages.

Declaration
public void TRACEMS(int lvl, J_MESSAGE_CODE code)
Parameters
Type Name Description
System.Int32 lvl

See emit_message(Int32) for description.

J_MESSAGE_CODE code

The message code.

See Also
emit_message(Int32)
| Improve this Doc View Source

TRACEMS(Int32, J_MESSAGE_CODE, Object[])

Shows informational and debugging messages.

Declaration
public void TRACEMS(int lvl, J_MESSAGE_CODE code, params object[] args)
Parameters
Type Name Description
System.Int32 lvl

See emit_message(Int32) for description.

J_MESSAGE_CODE code

The message code.

System.Object[] args

The parameters of message.

See Also
emit_message(Int32)
| Improve this Doc View Source

TRACEMS(Int32, Int32, Object[])

Shows informational and debugging messages.

Declaration
public void TRACEMS(int lvl, int code, params object[] args)
Parameters
Type Name Description
System.Int32 lvl

See emit_message(Int32) for description.

System.Int32 code

The message code.

System.Object[] args

The parameters of message.

See Also
emit_message(Int32)
| Improve this Doc View Source

WARNMS(J_MESSAGE_CODE)

Used for non-fatal errors (we can keep going, but the data is probably corrupt).

Declaration
public void WARNMS(J_MESSAGE_CODE code)
Parameters
Type Name Description
J_MESSAGE_CODE code

The message code.

| Improve this Doc View Source

WARNMS(J_MESSAGE_CODE, Object[])

Used for non-fatal errors (we can keep going, but the data is probably corrupt).

Declaration
public void WARNMS(J_MESSAGE_CODE code, params object[] args)
Parameters
Type Name Description
J_MESSAGE_CODE code

The message code.

System.Object[] args

The parameters of message.

| Improve this Doc View Source

WARNMS(Int32, Object[])

Used for non-fatal errors (we can keep going, but the data is probably corrupt).

Declaration
public void WARNMS(int code, params object[] args)
Parameters
Type Name Description
System.Int32 code

The message code.

System.Object[] args

The parameters of message.

  • Improve this Doc
  • View Source
Back to top Generated by DocFX