Class PvCompressionFilter

Filter used for image compression.

Inheritance
object
IPvFilter
PvCompressionFilter
Implements
Inherited Members
Namespace: eBUSDotNet
Assembly: eBUSDotNet.dll
Syntax
public class PvCompressionFilter : IPvFilter, IDisposable

Constructors

View Source

PvCompressionFilter()

Constructor.

Declaration
public PvCompressionFilter()

Properties

View Source

Encoding

Gets or sets the encoding used when compressing the image.

Declaration
public PvEncodingEnum Encoding { get; set; }
Property Value
Type Description
PvEncodingEnum
View Source

ThreadCount

ThreadCount property of PvCompressionFilter.

Declaration
public override uint ThreadCount { get; set; }
Property Value
Type Description
uint
Overrides

Methods

View Source

Dispose(bool)

Dispose

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
bool disposing
Overrides
View Source

Execute(PvBuffer, ref PvBuffer)

Compresses aIn into aOut.

Declaration
public override PvResult Execute(PvBuffer aIn, ref PvBuffer aOut)
Parameters
Type Name Description
PvBuffer aIn

Input buffer.
PvBuffer aOut

Output buffer.
Returns
Type Description
PvResult

Includes: - #PvResult::Code::OK - #PvResult::Code::INVALID_PARAMETER - #PvResult::Code::NOT_SUPPORTED if aIn cannot be compressed (not an image, pixel type not supported, etc)
Overrides
View Source

GetThreadsPriority(out uint)

Gets the thread priority of the filter's worker threads.

Declaration
public override PvResult GetThreadsPriority(out uint aPriority)
Parameters
Type Name Description
uint aPriority

Output reference to the worker threads priority.
Returns
Type Description
PvResult

Includes: - #PvResult::Code::OK - #PvResult::Code::NOT_SUPPORTED if the filter does not support multi-threading.
Overrides
View Source

SetThreadsPriority(uint)

Sets the thread priority of the filter's worker threads.

Declaration
public override PvResult SetThreadsPriority(uint aPriority)
Parameters
Type Name Description
uint aPriority

Priority to set the worker threads to.
Returns
Type Description
PvResult

Includes: - #PvResult::Code::OK - #PvResult::Code::NOT_SUPPORTED if the filter does not support multi-threading. - #PvResult::Code::INVALID_PARAMETER if aPriority maps to nothing on the target system.
Overrides

Implements