|   |  | 
Window creation, modification and destruction functions. More...
| Functions | |
| Window () | |
| Creates a window object with default width and height with title set to "ArrayFire".  More... | |
| Window (const char *const title) | |
| Creates a window object with default width and height using the title provided by the user.  More... | |
| Window (const int width, const int height, const char *const title="ArrayFire") | |
| Creates a window object using the parameters provided by the user.  More... | |
| Window (const af_window wnd) | |
| Creates a window object with default width and height with title set to "ArrayFire".  More... | |
| ~Window () | |
| Destroys the window handle.  More... | |
| af_window | get () const | 
| void | setPos (const unsigned x, const unsigned y) | 
| Set the start position where the window will appear.  More... | |
| void | setTitle (const char *const title) | 
| Set the window title.  More... | |
| void | setSize (const unsigned w, const unsigned h) | 
| Set the window size.  More... | |
| void | setColorMap (const ColorMap cmap) | 
| Set the colormap to be used for subsequent rendering calls.  More... | |
| void | grid (const int rows, const int cols) | 
| Setup grid layout for multiview mode in a window.  More... | |
| void | show () | 
| This function swaps the background buffer to current view and polls for any key strokes while the window was in focus.  More... | |
| bool | close () | 
| Check if window is marked for close.  More... | |
| AFAPI af_err | af_create_window (af_window *out, const int width, const int height, const char *const title) | 
| C Interface wrapper for creating a window.  More... | |
| AFAPI af_err | af_set_position (const af_window wind, const unsigned x, const unsigned y) | 
| C Interface wrapper for setting the start position when window is displayed.  More... | |
| AFAPI af_err | af_set_title (const af_window wind, const char *const title) | 
| C Interface wrapper for setting window title.  More... | |
| AFAPI af_err | af_set_size (const af_window wind, const unsigned w, const unsigned h) | 
| C Interface wrapper for setting window position.  More... | |
| AFAPI af_err | af_grid (const af_window wind, const int rows, const int cols) | 
| C Interface wrapper for grid setup in a window.  More... | |
| AFAPI af_err | af_show (const af_window wind) | 
| C Interface wrapper for showing a window.  More... | |
| AFAPI af_err | af_is_window_closed (bool *out, const af_window wind) | 
| C Interface wrapper for checking if window is marked for close.  More... | |
| AFAPI af_err | af_destroy_window (const af_window wind) | 
| C Interface wrapper for destroying a window handle.  More... | |
Window creation, modification and destruction functions.
| AFAPI af_err af_create_window | ( | af_window * | out, | 
| const int | width, | ||
| const int | height, | ||
| const char *const | title | ||
| ) | 
C Interface wrapper for creating a window.
| [out] | out | is the handle to the created window | 
| [in] | width | is the width of the window that will be created | 
| [in] | height | is the height of the window that will be created | 
| [in] | title | is the window title | 
C Interface wrapper for destroying a window handle.
| [in] | wind | is the window handle | 
C Interface wrapper for grid setup in a window.
| [in] | wind | is the window handle | 
| [in] | rows | is number of rows you want to show in a window | 
| [in] | cols | is number of coloumns you want to show in a window | 
C Interface wrapper for checking if window is marked for close.
| [out] | out | is a boolean which indicates whether window is marked for close. This usually happens when user presses ESC key while the window is in focus. | 
| [in] | wind | is the window handle | 
wind show is successful, otherwise an appropriate error code is returned. C Interface wrapper for setting the start position when window is displayed.
| [in] | wind | is the window handle | 
| [in] | x | is horizontal start coordinate | 
| [in] | y | is vertical start coordinate | 
C Interface wrapper for setting window position.
| [in] | wind | is the window handle | 
| [in] | w | is target width of the window | 
| [in] | h | is target height of the window | 
C Interface wrapper for setting window title.
| [in] | wind | is the window handle | 
| [in] | title | is title of the window | 
C Interface wrapper for showing a window.
| [in] | wind | is the window handle | 
| bool close | ( | ) | 
Check if window is marked for close.
This usually happens when user presses ESC key while the window is in focus.
| void grid | ( | const int | rows, | 
| const int | cols | ||
| ) | 
Setup grid layout for multiview mode in a window.
| [in] | rows | is number of rows you want to show in a window | 
| [in] | cols | is number of coloumns you want to show in a window | 
| void setColorMap | ( | const ColorMap | cmap | ) | 
| void setPos | ( | const unsigned | x, | 
| const unsigned | y | ||
| ) | 
Set the start position where the window will appear.
| [in] | x | is horizontal coordinate | 
| [in] | y | is vertical coordinate | 
| void setSize | ( | const unsigned | w, | 
| const unsigned | h | ||
| ) | 
Set the window size.
| [in] | w | is target width of the window | 
| [in] | h | is target height of the window | 
| void setTitle | ( | const char *const | title | ) | 
Set the window title.
| [in] | title | is the window title | 
| void show | ( | ) | 
This function swaps the background buffer to current view and polls for any key strokes while the window was in focus.
| Window | ( | ) | 
Creates a window object with default width and height with title set to "ArrayFire".
| Window | ( | const char *const | title | ) | 
Creates a window object with default width and height using the title provided by the user.
| [in] | title | is the window title | 
| Window | ( | const int | width, | 
| const int | height, | ||
| const char *const | title = "ArrayFire" | ||
| ) | 
Creates a window object using the parameters provided by the user.
| [in] | width | is the window width | 
| [in] | height | is the window height | 
| [in] | title | is the window title with default value as "ArrayFire" | 
| Window | ( | const af_window | wnd | ) | 
| ~Window | ( | ) | 
Destroys the window handle.