Class Display
Abstract base class for display implementations
Inherited Members
Namespace: ic4
Assembly: ic4dotnet.dll
Syntax
public abstract class Display : HandleObject, IDisposable, IDisplayProperties
RenderHeight
The height of the target rectangle inside the display
Declaration
public int RenderHeight { get; set; }Property Value
| Type | Description |
|---|---|
| int | The height of the target rectangle inside the display |
Exceptions
| Type | Condition |
|---|---|
| IC4Exception | Check ErrorCode and ToString() for details. |
RenderLeft
The left coordinate of the target rectangle inside the display
Declaration
public int RenderLeft { get; set; }Property Value
| Type | Description |
|---|---|
| int | The left coordinate of the target rectangle inside the display |
Exceptions
| Type | Condition |
|---|---|
| IC4Exception | Check ErrorCode and ToString() for details. |
RenderPosition
The scaling and alignment mode to use
Declaration
public DisplayRenderPosition RenderPosition { get; set; }Property Value
| Type | Description |
|---|---|
| DisplayRenderPosition | The scaling and alignment mode to use |
Exceptions
| Type | Condition |
|---|---|
| IC4Exception | Check ErrorCode and ToString() for details. |
RenderTop
The top coordinate of the target rectangle inside the display
Declaration
public int RenderTop { get; set; }Property Value
| Type | Description |
|---|---|
| int | The top coordinate of the target rectangle inside the display |
Exceptions
| Type | Condition |
|---|---|
| IC4Exception | Check ErrorCode and ToString() for details. |
RenderWidth
The width of the target rectangle inside the display
Declaration
public int RenderWidth { get; set; }Property Value
| Type | Description |
|---|---|
| int | The width of the target rectangle inside the display |
Exceptions
| Type | Condition |
|---|---|
| IC4Exception | Check ErrorCode and ToString() for details. |
Statistics
Queries display statistics.
Declaration
public DisplayStatistics Statistics { get; }Property Value
| Type | Description |
|---|---|
| DisplayStatistics | A structure contains display statistics |
Exceptions
| Type | Condition |
|---|---|
| IC4Exception | Check ErrorCode and ToString() for details. |
Methods
DisplayBuffer(ImageBuffer)
Displays a specific image buffer.
Declaration
public void DisplayBuffer(ImageBuffer buffer)Parameters
| Type | Name | Description |
|---|---|---|
| ImageBuffer | buffer | The buffer to display |
Remarks
When buffer is null, the display is cleared and will no longer display the previous buffer.
Exceptions
| Type | Condition |
|---|---|
| IC4Exception | Check ErrorCode and ToString() for details. |
Events
WindowClosed
Occurs when the display window is closed.
Declaration
public event EventHandler WindowClosedEvent Type
| Type | Description |
|---|---|
| EventHandler |
