    

 ## On this page

  

 

 # ensightservice::ImageReply Struct Reference

 Last update: 16.07.2025 

An image frame message. [More...](structensightservice_1_1_image_reply.xhtml#details)

## <a id="pub-types" name="pub-types"></a>Public Types

enum [CompressionType](structensightservice_1_1_image_reply.xhtml#a9bfd8548c69ab349c9e3a25f1301014f) { [NONE](structensightservice_1_1_image_reply.xhtml#a9bfd8548c69ab349c9e3a25f1301014fa2617c314c1b65a7be10501baac8af39e) = 0 } the pixel compression, if any [More...](structensightservice_1_1_image_reply.xhtml#a9bfd8548c69ab349c9e3a25f1301014f)  
 ## <a id="pub-attribs" name="pub-attribs"></a>Public Attributes

<a id="a27122c861af05800091d1100186a84f3"></a>int32 [width](structensightservice_1_1_image_reply.xhtml#a27122c861af05800091d1100186a84f3) = 1 The width of the image in pixels.   
 <a id="a458d8f403ce40efee41992b095dfa977"></a>int32 [height](structensightservice_1_1_image_reply.xhtml#a458d8f403ce40efee41992b095dfa977) = 2 The height of the image in pixels.   
 <a id="adbf4e4047fda62f949053243c236810e"></a>[CompressionType](structensightservice_1_1_image_reply.xhtml#a9bfd8548c69ab349c9e3a25f1301014f) [compression](structensightservice_1_1_image_reply.xhtml#adbf4e4047fda62f949053243c236810e) = 3 The compression scheme used for the pixel data payload.   
 <a id="a27bb77c84bb8f94477b341dd4f669842"></a>bytes [pixels](structensightservice_1_1_image_reply.xhtml#a27bb77c84bb8f94477b341dd4f669842) = 4 The pixel data in RGBRGBRGB... form, width\*height\*3 bytes.   
 <a id="aacf31b61824c9e3bc57f002d5a7ea640"></a>bool [final](structensightservice_1_1_image_reply.xhtml#aacf31b61824c9e3bc57f002d5a7ea640) = 5 If the [ImageStreamRequest](structensightservice_1_1_image_stream_request.xhtml "Request the start of an image stream.") chunk is true, this is the final message in an image frame.   
 <a id="details" name="details"></a>## Detailed Description

An image frame message.

These messages can contain the pixel data for an entire image or some portion of the image. An image frame can be broken up into multiple [ImageReply](structensightservice_1_1_image_reply.xhtml "An image frame message.") messages. If the client receives an [ImageReply](structensightservice_1_1_image_reply.xhtml "An image frame message.") message with the final flag set to false, it must continue reading messages, concatenating the pixels data until it receives an [ImageReply](structensightservice_1_1_image_reply.xhtml "An image frame message.") with the final flag set to true.

Definition at line [343](ensight_8proto_source.xhtml#l00343) of file [ensight.proto](ensight_8proto_source.xhtml).



## Member Enumeration Documentation

<a id="a9bfd8548c69ab349c9e3a25f1301014f"></a>## [◆ ](#a9bfd8548c69ab349c9e3a25f1301014f)CompressionType

 enum [ensightservice::ImageReply::CompressionType](structensightservice_1_1_image_reply.xhtml#a9bfd8548c69ab349c9e3a25f1301014f)

the pixel compression, if any

Enumerator<a id="a9bfd8548c69ab349c9e3a25f1301014fa2617c314c1b65a7be10501baac8af39e"></a>NONE The data are in raw-binary uncompressed format.

Definition at line [348](ensight_8proto_source.xhtml#l00348) of file [ensight.proto](ensight_8proto_source.xhtml).





---

The documentation for this struct was generated from the following file:- D:/ANSYSDev/NoBackup/branches/EnSight-Second-Coming/ensight/client/rpc\_interface/[ensight.proto](ensight_8proto_source.xhtml)