## On this page

  

 

 # ensightservice::RenderRequest Struct Reference

 Last update: 16.07.2025 

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

enum [RenderType](structensightservice_1_1_render_request.xhtml#a98477acc54de7574602f36ed266c4122) { [IMAGE\_PNG](structensightservice_1_1_render_request.xhtml#a98477acc54de7574602f36ed266c4122a24ca50772e6eb62831dc1b5859234328) = 0 , [IMAGE\_RAW](structensightservice_1_1_render_request.xhtml#a98477acc54de7574602f36ed266c4122a1984c4e599cd46467c28ae82a91893d8) = 1 } ## <a id="pub-attribs" name="pub-attribs"></a>Public Attributes

[RenderType](structensightservice_1_1_render_request.xhtml#a98477acc54de7574602f36ed266c4122) [type](structensightservice_1_1_render_request.xhtml#aefa3944f221f219bddc1b996d41ce3f6) = 1 int32 [image\_width](structensightservice_1_1_render_request.xhtml#acc1fccf32ccf502623426d71bd90c4f0) = 2 int32 [image\_height](structensightservice_1_1_render_request.xhtml#af8d0600e4baa6e53e760b4ab65fcebd8) = 3 int32 [image\_aa\_passes](structensightservice_1_1_render_request.xhtml#af5e5b4a7e1a519149f50a6a6f980f34a) = 4 bool [include\_highlighting](structensightservice_1_1_render_request.xhtml#a7c270f2115888abd7d06fdbf6966ad93) = 5 <a id="details" name="details"></a>## Detailed Description

Control options for a single image render request

Definition at line [221](ensight_8proto_source.xhtml#l00221) of file [ensight.proto](ensight_8proto_source.xhtml).



## Member Enumeration Documentation

<a id="a98477acc54de7574602f36ed266c4122" name="a98477acc54de7574602f36ed266c4122"></a>## [◆ ](#a98477acc54de7574602f36ed266c4122)RenderType

 enum [ensightservice::RenderRequest::RenderType](structensightservice_1_1_render_request.xhtml#a98477acc54de7574602f36ed266c4122)

Specify the return type of the rendering request.

Enumerator<a id="a98477acc54de7574602f36ed266c4122a24ca50772e6eb62831dc1b5859234328" name="a98477acc54de7574602f36ed266c4122a24ca50772e6eb62831dc1b5859234328"></a>IMAGE\_PNG The returned image will be encoded into the PNG image file format and returned as an array of bytes.

<a id="a98477acc54de7574602f36ed266c4122a1984c4e599cd46467c28ae82a91893d8" name="a98477acc54de7574602f36ed266c4122a1984c4e599cd46467c28ae82a91893d8"></a>IMAGE\_RAW The returned value be in raw binary bytes: RGBRGBRGB... width\*height\*3 bytes total.

Definition at line [224](ensight_8proto_source.xhtml#l00224) of file [ensight.proto](ensight_8proto_source.xhtml).





## Member Data Documentation

<a id="af5e5b4a7e1a519149f50a6a6f980f34a" name="af5e5b4a7e1a519149f50a6a6f980f34a"></a>## [◆ ](#af5e5b4a7e1a519149f50a6a6f980f34a)image\_aa\_passes

 int32 ensightservice::RenderRequest::image\_aa\_passes = 4

The number of anti-aliasing passes to be applied.

Definition at line [231](ensight_8proto_source.xhtml#l00231) of file [ensight.proto](ensight_8proto_source.xhtml).





<a id="af8d0600e4baa6e53e760b4ab65fcebd8" name="af8d0600e4baa6e53e760b4ab65fcebd8"></a>## [◆ ](#af8d0600e4baa6e53e760b4ab65fcebd8)image\_height

 int32 ensightservice::RenderRequest::image\_height = 3

The desired image height in pixels.

Definition at line [230](ensight_8proto_source.xhtml#l00230) of file [ensight.proto](ensight_8proto_source.xhtml).





<a id="acc1fccf32ccf502623426d71bd90c4f0" name="acc1fccf32ccf502623426d71bd90c4f0"></a>## [◆ ](#acc1fccf32ccf502623426d71bd90c4f0)image\_width

 int32 ensightservice::RenderRequest::image\_width = 2

The desired image width in pixels.

Definition at line [229](ensight_8proto_source.xhtml#l00229) of file [ensight.proto](ensight_8proto_source.xhtml).





<a id="a7c270f2115888abd7d06fdbf6966ad93" name="a7c270f2115888abd7d06fdbf6966ad93"></a>## [◆ ](#a7c270f2115888abd7d06fdbf6966ad93)include\_highlighting

 bool ensightservice::RenderRequest::include\_highlighting = 5

If true, any dynamic overlay will be included in the rendered image.

Definition at line [232](ensight_8proto_source.xhtml#l00232) of file [ensight.proto](ensight_8proto_source.xhtml).





<a id="aefa3944f221f219bddc1b996d41ce3f6" name="aefa3944f221f219bddc1b996d41ce3f6"></a>## [◆ ](#aefa3944f221f219bddc1b996d41ce3f6)type

 [RenderType](structensightservice_1_1_render_request.xhtml#a98477acc54de7574602f36ed266c4122) ensightservice::RenderRequest::type = 1

Select the format the returned image should be in.

Definition at line [228](ensight_8proto_source.xhtml#l00228) of file [ensight.proto](ensight_8proto_source.xhtml).





---

The documentation for this struct was generated from the following file:- D:/Product-src/ensight/client/rpc\_interface/[ensight.proto](ensight_8proto_source.xhtml)