C# Class Microsoft.Protocols.TestTools.StackSdk.RemoteDesktop.Rdpegfx.RDPGFX_WIRE_TO_SURFACE_PDU_1

The RDPGFX_WIRE_TO_SURFACE_PDU_1 message is to used to transfer encoded bitmap data from the server to a client-side destination surface. it support NSCodec, RemoteFX Codec, ClearCodec, and Planar Codec.
Inheritance: RdpegfxServerPdu
Show file Open project: Microsoft/WindowsProtocolTestSuites

Public Properties

Property Type Description
bitmapData byte[]
bitmapDataLength uint
codecId CodecType
destRect RDPGFX_RECT16
pixelFormat PixelFormat
surfaceId ushort

Public Methods

Method Description
Decode ( Microsoft.Protocols.TestTools.StackSdk.PduMarshaler marshaler ) : bool

Decode this PDU from the PduMarshaler.
Encode ( Microsoft.Protocols.TestTools.StackSdk.PduMarshaler marshaler ) : void

Encode this PDU to the PduMarshaler.
RDPGFX_WIRE_TO_SURFACE_PDU_1 ( ) : System

Constructor
RDPGFX_WIRE_TO_SURFACE_PDU_1 ( ushort sId, CodecType cId, PixelFormat pixFormat, RDPGFX_RECT16 bmRect, byte bmData ) : System

Constructor, create a wire to surface message to transfer a bitmap.

Method Details

Decode() public method

Decode this PDU from the PduMarshaler.
public Decode ( Microsoft.Protocols.TestTools.StackSdk.PduMarshaler marshaler ) : bool
marshaler Microsoft.Protocols.TestTools.StackSdk.PduMarshaler This is used to decode the fields of this PDU.
return bool

Encode() public method

Encode this PDU to the PduMarshaler.
public Encode ( Microsoft.Protocols.TestTools.StackSdk.PduMarshaler marshaler ) : void
marshaler Microsoft.Protocols.TestTools.StackSdk.PduMarshaler This is used to encode the fields of this PDU.
return void

RDPGFX_WIRE_TO_SURFACE_PDU_1() public method

Constructor
public RDPGFX_WIRE_TO_SURFACE_PDU_1 ( ) : System
return System

RDPGFX_WIRE_TO_SURFACE_PDU_1() public method

Constructor, create a wire to surface message to transfer a bitmap.
public RDPGFX_WIRE_TO_SURFACE_PDU_1 ( ushort sId, CodecType cId, PixelFormat pixFormat, RDPGFX_RECT16 bmRect, byte bmData ) : System
sId ushort This is used to indicate the target surface id.
cId CodecType This is used to indicate the codecId.
pixFormat PixelFormat This is used to indicate the pixel format to fill target surface.
bmRect RDPGFX_RECT16 This is used to indicate border of bitmap on target surface.
bmData byte This is used to indicate the bitmap data encoded by cId codec.
return System

Property Details

bitmapData public property

A variable-length array of bytes. specify bitmap data encoded using the codec identified by the ID in the codecId field.
public byte[] bitmapData
return byte[]

bitmapDataLength public property

A 32-bit, unsigned integer. Specify the length, in bytes, of the bitmapData field.
public uint bitmapDataLength
return uint

codecId public property

A 16-bit, unsigned integer. specify the codec that was used to encode the bitmap data. encapsulated in the bitmapData field.
public CodecType codecId
return CodecType

destRect public property

A RDPGFX_RECT16 structure(8 bytes). the target point on the destination surface to which to copy the decoded bitmap and the dimensions (width and height) of the bitmap data.
public RDPGFX_RECT16,Microsoft.Protocols.TestTools.StackSdk.RemoteDesktop.Rdpegfx destRect
return RDPGFX_RECT16

pixelFormat public property

A 8-bit, unsigned integer. specify the pixel format of the decoded bitmap data.
public PixelFormat pixelFormat
return PixelFormat

surfaceId public property

A 16-bit, unsigned integer. specify the ID of the destination surface. A 16-bit, unsigned integer. specify the ID of the destination surface.
public ushort surfaceId
return ushort