Interface IFrameEncodingType

Represents a RFB protocol encoding type for (part of) a frame.

Inherited Members

IEncodingType.Id

IEncodingType.Name

IEncodingType.Priority

IEncodingType.GetsConfirmed

Namespace: MarcusW.VncClient.Protocol.EncodingTypes

Assembly: MarcusW.VncClient.dll

Syntax

public interface IFrameEncodingType : IEncodingType

Properties

VisualizationColor

Gets a distinctive color for visualizing rectangles that were encoded with this type (when enabled).

Declaration

Color VisualizationColor { get; }

Property Value

Type	Description
Color

Methods

ReadFrameEncoding(Stream, IFramebufferReference, Rectangle, Size, PixelFormat)

Reads a (partial) frame from the transport stream, decodes it and renders it to the target framebuffer, if available.

Declaration

void ReadFrameEncoding(Stream transportStream, IFramebufferReference targetFramebuffer, in Rectangle rectangle, in Size remoteFramebufferSize, in PixelFormat remoteFramebufferFormat)

Parameters

Type	Name	Description
Stream	transportStream	The stream to read from.
IFramebufferReference	targetFramebuffer	The target framebuffer reference, or null if unavailable.
Rectangle	rectangle	The part of the frame to update.
Size	remoteFramebufferSize	The current size of the remote framebuffer.
PixelFormat	remoteFramebufferFormat	The current pixel format.