Skip to content

get_window_paramGetWindowParamGetWindowParamget_window_paramT_get_window_param🔗

Short description🔗

get_window_paramGetWindowParamGetWindowParamget_window_paramT_get_window_param — Get window parameters.

Signature🔗

get_window_param( window WindowHandle, string Param, out string Value )void GetWindowParam( const HTuple& WindowHandle, const HTuple& Param, HTuple* Value )static void HOperatorSet.GetWindowParam( HTuple windowHandle, HTuple param, out HTuple value )def get_window_param( window_handle: HHandle, param: str ) -> Sequence[Union[str, float, int]]

def get_window_param_s( window_handle: HHandle, param: str ) -> Union[str, float, int]Herror T_get_window_param( const Htuple WindowHandle, const Htuple Param, Htuple* Value )

HTuple HWindow::GetWindowParam( const HString& Param ) const

HTuple HWindow::GetWindowParam( const char* Param ) const

HTuple HWindow::GetWindowParam( const wchar_t* Param ) const (Windows only)

HTuple HWindow.GetWindowParam( string param )

Description🔗

The operator get_window_paramGetWindowParam allows querying different parameters of an open window. For detailed descriptions of the individual parameters see set_window_paramSetWindowParam.

General window parameters:

  • 'flush'"flush" 'true'"true" if automatic flushing is enabled, 'false'"false" otherwise.

  • 'region_quality'"region_quality" Quality of the rendering of regions.

  • 'background_color'"background_color" The background color of the window WindowHandlewindowHandlewindow_handle.

  • 'window_title'"window_title" The text in the title bar of the window WindowHandlewindowHandlewindow_handle.

  • 'anti_aliasing'"anti_aliasing" 'true'"true" if anti aliasing is enabled, 'false'"false" otherwise.

  • 'graphics_stack'"graphics_stack" 'true'"true" if the graphics stack is enabled, 'false'"false" otherwise.

  • 'graphics_stack_max_element_num'"graphics_stack_max_element_num" Maximum number of elements in the graphics stack.

  • 'graphics_stack_max_memory_size'"graphics_stack_max_memory_size" Maximum memory consumption of the graphics stack.

  • 'pixel_grid_enable'"pixel_grid_enable" 'true'"true" if the pixel grid is enabled for the window WindowHandlewindowHandlewindow_handle.

  • 'pixel_grid_min_resolution'"pixel_grid_min_resolution" Minimal required resolution of one pixel in the window WindowHandlewindowHandlewindow_handle such that the pixel grid becomes visible.

  • 'pixel_grid_color'"pixel_grid_color" Color of the pixel grid lines.

  • 'pixel_grid_line_width'"pixel_grid_line_width" Line width of the pixel grid lines.

Parameters concerning the '3d_plot'"3d_plot":

  • 'angle_of_view'"angle_of_view" The angle of view of the virtual camera used to display the 3D plot.

  • 'axis_captions'"axis_captions" The captions for row, column, and height axis.

  • 'plot_quality'"plot_quality" The quality of the 3D plot.

  • 'scale_plot'"scale_plot" 'true'"true" if the height values of an image are transformed into the interval [0,255] before display, 'false'"false" otherwise.

  • 'display_grid'"display_grid" 'true'"true" if the grid is displayed.

  • 'display_axes'"display_axes" 'true'"true" if the coordinate axes are displayed.

Attention🔗

The parameters 'anti_aliasing'"anti_aliasing", 'flush'"flush", 'graphics_stack'"graphics_stack", 'graphics_stack_max_element_num'"graphics_stack_max_element_num", 'graphics_stack_max_memory_size'"graphics_stack_max_memory_size", and 'region_quality'"region_quality" depend on the library libcanvas, which might not be available on embedded systems.

Execution information🔗

Execution information

  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).

  • Multithreading scope: global (may be called from any thread).

  • Processed without parallelization.

Parameters🔗

WindowHandlewindowHandlewindow_handle (input_control) window → (handle)HTuple (HHandle)HWindow, HTuple (IntPtr)HHandleHtuple (handle)

Window handle.

Paramparamparam (input_control) string → (string)HTuple (HString)HTuple (string)strHtuple (char*)

Name of the parameter.

Default: 'flush'"flush"
List of values: 'angle_of_view', 'axis_captions', 'background_color', 'display_axes', 'display_grid', 'flush', 'graphics_stack', 'graphics_stack_max_element_num', 'graphics_stack_max_memory_size', 'pixel_grid_color', 'pixel_grid_enable', 'pixel_grid_line_width', 'pixel_grid_min_resolution', 'plot_quality', 'region_quality', 'scale_plot', 'window_title'"angle_of_view", "axis_captions", "background_color", "display_axes", "display_grid", "flush", "graphics_stack", "graphics_stack_max_element_num", "graphics_stack_max_memory_size", "pixel_grid_color", "pixel_grid_enable", "pixel_grid_line_width", "pixel_grid_min_resolution", "plot_quality", "region_quality", "scale_plot", "window_title"

Valuevaluevalue (output_control) string(-array) → (string / real / integer)HTuple (HString / double / Hlong)HTuple (string / double / int / long)Sequence[Union[str, float, int]]Htuple (char* / double / Hlong)

Value of the parameter.

Combinations with other operators🔗

Combinations

Possible predecessors

open_windowOpenWindow

Possible successors

set_window_paramSetWindowParam

See also

get_window_attrGetWindowAttr, get_part_styleGetPartStyle

Module🔗

Foundation