---
name: "icetGetFloatv"
section: "3"
platform: "linux"
package: "paraview"
version: "5.13.2+dfsg-3"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/icetGetFloatv"
---

# icetGetFloatv(3)

## NAME

**icetGet -- get an IceT state parameter**

## Synopsis

**#include \<IceT.h\>**

| | | |
| --- | --- | --- |
| void **icetGetDoublev**( | IceTEnum | *pname*, |
|  | IceTDouble \* | *params* ); |

| | | |
| --- | --- | --- |
| void **icetGetFloatv**( | IceTEnum | *pname*, |
|  | IceTFloat \* | *params* ); |

| | | |
| --- | --- | --- |
| void **icetGetIntegerv**( | IceTEnum | *pname*, |
|  | IceTInt \* | *params* ); |

| | | |
| --- | --- | --- |
| void **icetGetBooleanv**( | IceTEnum | *pname*, |
|  | IceTBoolean \* | *params* ); |

| | | |
| --- | --- | --- |
| void **icetGetEnumv**( | IceTEnum | *pname*, |
|  | IceTEnum \* | *params* ); |

| | | |
| --- | --- | --- |
| void **icetGetBitFieldv**( | IceTEnum | *pname*, |
|  | IceTBitField \* | *params* ); |

| | | |
| --- | --- | --- |
| void **icetGetPointerv**( | IceTEnum | *pname*, |
|  | IceTVoid \*\* | *params* ); |

## Description

**Like OpenGL ,the operation of IceT is defined by a large state machine.** **Also like OpenGL ,the state parameters can be retrieved through the** **icetGet** **functions. Each function takes a symbolic constant,** *pname***,** **which identifies the state parameter to retrieve. They** **also each take an array,** *params***,** **which will be filled with the** **values in** *pname***.** **It is the calling application's responsibility** **to ensure that** *params* **is big enough to hold all the data.**

## State Parameters

**The following list identifies valid values for** *pname* **and a** **description of the associated state parameter.**

- **ICET\_BACKGROUND\_COLOR**

   **The color that IceT is currently** **assuming is the background color. It is an RGBA value that is stored** **as four floating point values. This value is set either to the last** **value passed to icetDrawFrame** **or icetCompositeImage,** **the OpenGL background color if icetGLDrawFrame** **was called, or** **to black for color blending. (The correct background color is restored** **later.)**

- **ICET\_BACKGROUND\_COLOR\_WORD**

   **The same as** **ICET\_BACKGROUND\_COLOR** **except that each component is stored as** **8-bit RGBA values and packed in a 4-byte integer. The idea is to** **rapidly fill the background of color buffers.**

- **ICET\_BLEND\_TIME**

   **The total time, in seconds, spent in** **performing color blending of images during the last call to** **icetDrawFrame,** **icetCompositeImage,** **or** **icetGLDrawFrame.** **Stored as a double. An alias for this value** **is ICET\_COMPARE\_TIME.**

- **ICET\_BUFFER\_READ\_TIME**

   **The total time, in seconds, spent** **copying buffer data and reading from OpenGL buffers during the last** **call to icetDrawFrame,** **icetCompositeImage,** **or** **icetGLDrawFrame.** **Stored as a double.**

- **ICET\_BUFFER\_WRITE\_TIME**

   **The total time, in seconds,** **spent writing to OpenGL buffers during the last call to** **icetGLDrawFrame.** **Always set to 0.0 after a call to** **icetDrawFrame** **or icetCompositeImage.** **Stored as a** **double.**

- **ICET\_BYTES\_SENT**

   **The total number of bytes sent by the** **calling process for transferring image data during the last call to** **icetDrawFrame,** **icetCompositeImage,** **or** **icetGLDrawFrame.** **Stored as an integer.**

- **ICET\_COLLECT\_TIME**

   **The total time spent in collecting** **image fragments to display processes during the last call to** **icetDrawFrame,** **icetCompositeImage,** **or** **icetGLDrawFrame.**

- **ICET\_COLOR\_FORMAT**

   **The color format of images to be** **created by the rendering subsystem and composited by IceT .Use** **icetSetColorFormat** **to set the color format. Use** **icetImageGetColorFormat** **to safely get the color format for a** **particular image.**

- **ICET\_COMPARE\_TIME**

   **The total time, in seconds, spent in** **performing Z comparisons of images during the last call to** **icetDrawFrame,** **icetCompositeImage,** **or** **icetGLDrawFrame.** **Stored as a double. An alias for this value** **is ICET\_BLEND\_TIME.**

- **ICET\_COMPOSITE\_MODE**

   **The composite mode set by** **icetCompositeMode.** **A single entry stored as an** **IceTEnum.**

- **ICET\_COMPOSITE\_ORDER**

   **The order in which images are to be** **composited if ICET\_ORDERED\_COMPOSITE** **is enabled and the** **current strategy supports ordered compositing. The parameter contains** **ICET\_NUM\_PROCESSES** **entries. The value of this parameter is** **set with icetCompositeOrder.** **If the element of index i in** **the array is set to j, then there are i images \`\`on top'' of the** **image generated by process j.**

- **ICET\_COMPOSITE\_TIME**

   **The total time, in seconds, spent in** **compositing during the last call to icetDrawFrame,** **icetCompositeImage,** **or icetGLDrawFrame.** **Equal to** **$ICET\_TOTAL\_DRAW\_TIME** **- ICET\_RENDER\_TIME** **-** **ICET\_BUFFER\_READ\_TIME** **- ICET\_BUFFER\_WRITE\_TIME$.** **Stored as a double.**

- **ICET\_COMPRESS\_TIME**

   **The total time, in seconds, spent in** **compressing image data using active pixel encoding during the last call** **to icetDrawFrame,** **icetCompositeImage,** **or** **icetGLDrawFrame.** **Stored as a double.**

- **ICET\_DATA\_REPLICATION\_GROUP**

   **An array of process ids.** **There are ICET\_DATA\_REPLICATION\_GROUP\_SIZE** **entries in the** **array. IceT assumes that all processes in the list will create the** **exact same image with their draw functions (set with** **icetDrawCallback** **or icetGLDrawCallback).** **The local** **process id (ICET\_RANK)** **will be part of this list.**

- **ICET\_DATA\_REPLICATION\_GROUP\_SIZE**

   **The length of the** **ICET\_DATA\_REPLICATION\_GROUP** **array.**

- **ICET\_DEPTH\_FORMAT**

   **The depth format of images to be** **created by the rendering subsystem and composited by IceT .Use** **icetSetDepthFormat** **to set the depth format. Use** **icetImageGetDepthFormat** **to safely get the depth format for a** **particular image.**

- **ICET\_DIAGNOSTIC\_LEVEL**

   **The diagnostics flags set with** **icetDiagnostics.**

- **ICET\_DISPLAY\_NODES**

   **An array of process ranks. The size** **of the array is equal to the number of tiles** **(ICET\_NUM\_TILES).** **The $i^{th}$ entry is the rank of** **the process that is displaying the tile described by the** **$i^{th}$ entry in ICET\_TILE\_VIEWPORTS.**

- **ICET\_DRAW\_FUNCTION**

   **A pointer to the drawing callback** **function, as set by icetDrawCallback.**

- **ICET\_FRAME\_COUNT**

   **The number of times** **icetDrawFrame,** **icetCompositeImage,** **or** **icetGLDrawFrame** **has been called for the current context.**

- **ICET\_GEOMETRY\_BOUNDS**

   **An array of vertices whose convex** **hull bounds the drawn geometry. Set with icetBoundingVertices** **or icetBoundingBox.** **Each vertex has three coordinates and are** **tightly packed in the array. The size of the array is $3 \*** **ICET\_NUM\_BOUNDING\_VERTS$.**

- **ICET\_GLOBAL\_VIEWPORT**

   **Defines a viewport in an infinite** **logical display that covers all tile viewports (listed in** **ICET\_TILE\_VIEWPORTS).** **The viewport, like an OpenGL viewport,** **is given as the integer four-tuple $\<x, y, width, height** **\>$.x and y are placed at the leftmost and lowest position** **of all the tiles, and width and height are just big enough for the** **viewport to cover all tiles.**

- **ICET\_INTERLACE\_TIME**

   **The total time, in seconds, spent in** **copying pixels to interlace images for better load balancing during the** **last call to icetDrawFrame,** **icetCompositeImage,** **or** **icetGLDrawFrame.** **Stored as a double.**

- **ICET\_MAGIC\_K**

   **The target k value used when compositing** **with the radix-k single image strategy.**

- **ICET\_MAX\_IMAGE\_SPLIT**

   **The target number of maximum image** **splits to be performed by compositing strategies.**

- **ICET\_NUM\_BOUNDING\_VERTS**

   **The number of bounding vertices** **listed in the ICET\_GEOMETRY\_BOUNDS** **parameter.**

- **ICET\_NUM\_TILES**

   **The number of tiles in the defined** **display. Basically equal to the number of times icetAddTile** **was called after the last icetResetTiles.**

- **ICET\_NUM\_PROCESSES**

   **The number of processes in the** **parallel job as given by the IceTCommunicator** **object associated** **with the current context.**

- **ICET\_PHYSICAL\_RENDER\_HEIGHT**

   **The height of the images** **generated by the rendering system. This is set to the OpenGL viewport** **height by icetGLDrawFrame** **or otherwise by explicitly setting it** **with icetPhysicalRenderSize** **or otherwise implicitly to the** **largest tile height specified with icetAddTile.**

- **ICET\_PHYSICAL\_RENDER\_WIDTH**

   **The width of the images** **generated by the rendering system. This is set to the OpenGL viewport** **width by icetGLDrawFrame** **or otherwise by explicitly setting it** **with icetPhysicalRenderSize** **or otherwise implicitly to the** **largest tile width specified with icetAddTile.**

- **ICET\_PROCESS\_ORDERS**

   **Basically, the inverse of** **ICET\_COMPOSITE\_ORDER.** **The parameter contains** **ICET\_NUM\_PROCESSES** **entries. If the element of index i in** **the array is set to j, then there are j images \`\`on top'' of the** **image generated by process i.**

- **ICET\_RANK**

   **The rank of the process as given by the** **IceTCommunicator** **object associated with the current context.**

- **ICET\_RENDER\_TIME**

   **The total time, in seconds, spent in** **the drawing callback during the last call to icetDrawFrame** **or** **icetGLDrawFrame.** **Always set to 0.0 after a call to** **icetCompositeImage.** **Stored as a double.**

- **ICET\_SINGLE\_IMAGE\_STRATEGY**

   **The single image** **sub-strategy set with icetSingleImageStrategy.** **Use** **icetGetSingleImageStrategyName** **to get a user-readable name for** **the single image strategy.**

- **ICET\_STRATEGY**

   **The strategy set with** **icetStrategy.** **Use icetGetStrategyName** **to get a** **user-readable name for the strategy.**

- **ICET\_STRATEGY\_SUPPORTS\_ORDERING**

   **Is true if and only if** **the current strategy supports ordered compositing.**

- **ICET\_TILE\_DISPLAYED**

   **The index of the tile the local** **process is displaying. The index will correspond to the tile entry in** **the ICET\_DISPLAY\_NODES** **and ICET\_TILE\_VIEWPORTS** **arrays. If set to $0 \<= i \< ICET\_NUM\_PROCESSES$,** **then the** **$i^{th}$ entry of ICET\_DISPLAY\_NODES** **is equal to** **ICET\_RANK.** **If the local process is not displaying any tile,** **then ICET\_TILE\_DISPLAYED** **is set to -1.**

- **ICET\_TILE\_MAX\_HEIGHT**

   **The maximum height of any tile.**

- **ICET\_TILE\_MAX\_WIDTH**

   **The maximum width of any tile.**

- **ICET\_TILE\_VIEWPORTS**

   **A list of viewports in the logical** **global display defining the tiles. Each viewport is the four-tuple** **$\<x, y, width, height \>$defining the position and** **dimensions of a tile in pixels, much like a viewport is defined in** **OpenGL .The size of the array is $4 \* ICET\_NUM\_TILES$.** **The** **viewports are listed in the same order as the tiles were defined with** **icetAddTile.**

- **ICET\_TOTAL\_DRAW\_TIME**

   **Time spent in the last call to** **icetDrawFrame,** **icetCompositeImage,** **or** **icetGLDrawFrame.** **This includes all the time to render, read** **back, compress, and composite images. Stored as a double.**

- **ICET\_VALID\_PIXELS\_NUM**

   **In conjunction with** **ICET\_VALID\_PIXELS\_OFFSET,** **gives the range of valid pixels** **for the last image returned from icetDrawFrame,** **icetCompositeImage,** **or icetGLDrawFrame.** **Given the** **arrays of pixels returned with the icetImageGetColor** **and** **icetImageGetDepth** **functions, the valid pixels start at the** **pixel indexed by ICET\_VALID\_PIXELS\_OFFSET** **and continue for** **ICET\_VALID\_PIXELS\_NUM.** **The tile to which these pixels** **belong are captured in the ICET\_VALID\_PIXELS\_TILE** **state** **variable. If the last call to icetDrawFrame,** **icetCompositeImage,** **or icetGLDrawFrame** **did not return** **pixels for the local process, ICET\_VALID\_PIXELS\_NUM** **is set** **to 0. This state variable is only useful when** **ICET\_COLLECT\_IMAGES** **is off. If on, it can be assumed that** **all display processes contain all pixels in the image** **(ICET\_VALID\_PIXELS\_NUM** **is the number of pixels in the** **image), and all other processes have no pixel data.**

- **ICET\_VALID\_PIXELS\_OFFSET**

   **In conjunction with** **ICET\_VALID\_PIXELS\_NUM,** **gives the range of valid pixels for** **the last image returned from icetDrawFrame,** **icetCompositeImage,** **or icetGLDrawFrame.** **Given the** **arrays of pixels returned with the icetImageGetColor** **and** **icetImageGetDepth** **functions, the valid pixels start at the** **pixel indexed by ICET\_VALID\_PIXELS\_OFFSET** **and continue for** **ICET\_VALID\_PIXELS\_NUM.** **The tile to which these pixels** **belong are captured in the ICET\_VALID\_PIXELS\_TILE** **state** **variable. This state variable is only useful when** **ICET\_COLLECT\_IMAGES** **is off. If on, it can be assumed that** **all display processes contain all pixels in the image** **(ICET\_VALID\_PIXELS\_OFFSET** **is 0), and all other processes** **have no pixel data.**

- **ICET\_VALID\_PIXELS\_TILE**

   **Gives the tile for which the** **last image returned from icetDrawFrame,** **icetCompositeImage,** **or icetGLDrawFrame** **contains pixels.** **Each process has its own value. If the last call to** **icetDrawFrame,** **icetCompositeImage,** **or** **icetGLDrawFrame** **did not return pixels for the local process,** **then this state variable is set to -1. This state variable is only** **useful when ICET\_COLLECT\_IMAGES** **is off. If on, it can be** **assumed that all display processes have valid pixels for their** **respective display tiles, and all other processes have no pixel data.**

**In addition, if you are using the OpenGL layer (i.e., have called** **icetGLInitialize),** **these variables, defined in IceTGL.h,** **are also available.**

- **ICET\_GL\_DRAW\_FUNCTION**

   **A pointer to the OpenGL drawing** **callback function, as set by icetGLDrawCallback.**

- **ICET\_GL\_READ\_BUFFER**

   **The OpenGL buffer to read from** **(and write to). Set with icetGLSetReadBuffer.**

## Errors

- **ICET\_BAD\_CAST**

   **The state parameter requested is of a** **type that cannot be cast to the output type.**

- **ICET\_INVALID\_ENUM**

   *pname* **is not a valid state** **parameter.**

## Warnings

**None.**

## Bugs

**None known.**

## Notes

**Not every state variable is documented here. There is a set of** **parameters used internally by IceT or are more appropriately retrieved** **with other functions such as icetIsEnabled.**

## Copyright

**Copyright (C)2003 Sandia Corporation**

**Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation, the** **U.S. Government retains certain rights in this software.**

**This source code is released under the New BSD License.**

## See Also

*icetIsEnabled***(3),** *icetGetStrategyName***(3)**