Class PvDisplayThread

Manages a display thread for rendering buffers and reporting callbacks.

Inheritance

object

PvDisplayThread

Implements

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: eBUSDotNetReceive

Assembly: eBUSDotNetReceive.dll

Syntax

public class PvDisplayThread : IDisposable

Remarks

Register delegates to the events of a PvDisplayThread in order to receive notifications. The most common use of the display thread requires to register the OnBufferDisplay and handle buffer displaying in the handler.

Constructors

PvDisplayThread()

Constructor.

Declaration

public PvDisplayThread()

Fields

swigCMemOwn

Determines who is responsible for deleting the underlying C++ object.

Declaration

protected bool swigCMemOwn

Field Value

Type	Description
bool

Properties

BufferLogAllEnabled

Gets or sets whether logging for all buffers is enabled.

Declaration

public bool BufferLogAllEnabled { get; set; }

Property Value

Type	Description
bool

BufferLogErrorEnabled

Gets or sets whether buffer error logging is enabled.

Declaration

public bool BufferLogErrorEnabled { get; set; }

Property Value

Type	Description
bool

ChunkLogEnabled

Gets or sets whether chunk data logging is enabled.

Declaration

public bool ChunkLogEnabled { get; set; }

Property Value

Type	Description
bool

Deinterlacing

Gets or sets the deinterlacing mode.

Declaration

public SWIGTYPE_p_PvDeinterlacingType Deinterlacing { get; set; }

Property Value

Type	Description
SWIGTYPE_p_PvDeinterlacingType

DisplayChunkDataEnabled

Gets or sets whether chunk data display is enabled.

Declaration

public bool DisplayChunkDataEnabled { get; set; }

Property Value

Type	Description
bool

FPS

Gets the current frames per second being displayed.

Declaration

public uint FPS { get; }

Property Value

Type	Description
uint

IsRunning

Gets whether the display thread is running.

Declaration

public bool IsRunning { get; }

Property Value

Type	Description
bool

KeepPartialImagesEnabled

Gets or sets whether partial images are kept and displayed.

Declaration

public bool KeepPartialImagesEnabled { get; set; }

Property Value

Type	Description
bool

Remarks

If true, attempts to display images with missing packets or lines.

Priority

Gets or sets the display thread priority.

Declaration

public uint Priority { get; set; }

Property Value

Type	Description
uint

TapGeometry

Gets or sets the tap geometry for multi-tap sensors.

Declaration

public SWIGTYPE_p_PvTapGeometryEnum TapGeometry { get; set; }

Property Value

Type	Description
SWIGTYPE_p_PvTapGeometryEnum

TargetFPS

Gets or sets the target frames per second for display.

Declaration

public uint TargetFPS { get; set; }

Property Value

Type	Description
uint

Remarks

If the acquisition frame rate is higher than TargetFPS frames are dropped and not displayed. OnBufferDisplay is only invoked on frames that need to be displayed in order to meet TargetFPS.

VSyncEnabled

Gets or sets whether vertical sync is enabled.

Declaration

public bool VSyncEnabled { get; set; }

Property Value

Type	Description
bool

Methods

Dispose()

Dispose.

Declaration

public void Dispose()

Dispose(bool)

Dispose

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing

~PvDisplayThread()

Destructor.

Declaration

protected ~PvDisplayThread()

Load(PvPropertyList)

Loads display thread settings from a property list.

Declaration

public virtual PvResult Load(PvPropertyList aPropertyList)

Parameters

Type	Name	Description
PvPropertyList	aPropertyList	Property list containing settings to load.

Returns

Type	Description
PvResult	Result of the operation.

ReleaseCompressedBuffer()

Releases the most recent compressed buffer previously retrieved.

Declaration

public void ReleaseCompressedBuffer()

ReleaseLatestBuffer()

Releases the most recent buffer previously retrieved.

Declaration

public void ReleaseLatestBuffer()

ResetStatistics()

Resets display statistics.

Declaration

public void ResetStatistics()

RetrieveCompressedBuffer()

Retrieves the most recent compressed buffer.

Declaration

public PvBuffer RetrieveCompressedBuffer()

Returns

Type	Description
PvBuffer	Pointer to the most recent compressed PvBuffer.

RetrieveLatestBuffer()

Retrieves the most recent buffer from the pipeline.

Declaration

public PvBuffer RetrieveLatestBuffer()

Returns

Type	Description
PvBuffer	Pointer to the most recent PvBuffer.

Save(PvPropertyList)

Saves display thread settings to a property list.

Declaration

public virtual PvResult Save(PvPropertyList aPropertyList)

Parameters

Type	Name	Description
PvPropertyList	aPropertyList	Property list to receive current settings.

Returns

Type	Description
PvResult	Result of the operation.

Start(PvPipeline, PvGenParameterArray)

Starts the display thread using the provided pipeline and parameters.

Declaration

public PvResult Start(PvPipeline aPipeline, PvGenParameterArray aParameters)

Parameters

Type	Name	Description
PvPipeline	aPipeline	Pointer to the PvPipeline to retrieve buffers from.
PvGenParameterArray	aParameters	Pointer to the PvGenParameterArray for configuration.

Returns

Type	Description
PvResult	Result of the operation.

Stop(bool)

Stops the display thread.

Declaration

public PvResult Stop(bool aWait)

Parameters

Type	Name	Description
bool	aWait	Indicates whether to wait for the thread to stop.

Returns

Type	Description
PvResult	Result of the operation.

WaitComplete()

Waits for the display thread to finish stopping.

Declaration

public PvResult WaitComplete()

Returns

Type	Description
PvResult	Result of the operation.

Events

OnBufferDisplay

PvDisplayThread buffer needs to be displayed event delegate.

Declaration

public event OnBufferDisplay OnBufferDisplay

Event Type

Type	Description
OnBufferDisplay

OnBufferDone

PvDisplayThread finished using a buffer event delegate.

Declaration

public event OnBufferDone OnBufferDone

Event Type

Type	Description
OnBufferDone

OnBufferLog

PvDisplayThread buffer log entry was generated event delegate.

Declaration

public event OnBufferLog OnBufferLog

Event Type

Type	Description
OnBufferLog

OnBufferRetrieved

PvDisplayThread buffer was retrieved from the PvPipeline event delegate.

Declaration

public event OnBufferRetrieved OnBufferRetrieved

Event Type

Type	Description
OnBufferRetrieved

OnBufferTextOverlay

PvDisplayThread buffer text overlay is updated event delegate.

Declaration

public event OnBufferTextOverlay OnBufferTextOverlay

Event Type

Type	Description
OnBufferTextOverlay

Implements

IDisposable