diff --git a/components/nvidia-widgets/doc/nvcontext.xml b/components/nvidia-widgets/doc/nvcontext.xml new file mode 100644 index 000000000..0cd385c2d --- /dev/null +++ b/components/nvidia-widgets/doc/nvcontext.xml @@ -0,0 +1,75 @@ + + + + + + Basic UI context + + + Begin grouping section of UI objects + + User Interface library + + List item widget + + + + + + Listbox widget + + + + + + Combobox widget + + + + + + Line edit widget + + + + + + Frame positioning section + + + + + + Frame positioning widget + + + + + + Panel positioning widget + + + + + + Panel positioning widget + + + + + + NVIDIA widget library + +

This library is originally based on the NVIDIA widget library. NVIDIA Widgets is the +immediate mode graphical user interface toolkit used by the +NVIDIA SDK samples. +

+

Originally ported to FPC by Darius Blaszyk in June 2011.

+

This library is distributed under the MIT license, as the original library was.

+

The original code can be found here: +

+ +

For more information see the Lazarus wiki.

+
+
+
diff --git a/components/nvidia-widgets/doc/nvglwidgets.xml b/components/nvidia-widgets/doc/nvglpainter.xml similarity index 99% rename from components/nvidia-widgets/doc/nvglwidgets.xml rename to components/nvidia-widgets/doc/nvglpainter.xml index 4c5b5a585..333239877 100644 --- a/components/nvidia-widgets/doc/nvglwidgets.xml +++ b/components/nvidia-widgets/doc/nvglpainter.xml @@ -1,8 +1,8 @@ - - + + User Interface library diff --git a/components/nvidia-widgets/doc/nvglutwidgets.xml b/components/nvidia-widgets/doc/nvglutcontext.xml similarity index 98% rename from components/nvidia-widgets/doc/nvglutwidgets.xml rename to components/nvidia-widgets/doc/nvglutcontext.xml index 9c1436371..120d3543f 100644 --- a/components/nvidia-widgets/doc/nvglutwidgets.xml +++ b/components/nvidia-widgets/doc/nvglutcontext.xml @@ -1,7 +1,7 @@ - + Translate non-ascii keys from GLUT to nvWidgets diff --git a/components/nvidia-widgets/doc/nvpainter.xml b/components/nvidia-widgets/doc/nvpainter.xml new file mode 100644 index 000000000..096c91ad6 --- /dev/null +++ b/components/nvidia-widgets/doc/nvpainter.xml @@ -0,0 +1,16 @@ + + + + + Basic painter class + + Boolean evaluation function + +

This function evaluates a boolean to a numerical value.

+

True equals 1 +False equals 0

+
+
+
+
+
diff --git a/components/nvidia-widgets/doc/nvtypes.xml b/components/nvidia-widgets/doc/nvtypes.xml new file mode 100644 index 000000000..0747721ae --- /dev/null +++ b/components/nvidia-widgets/doc/nvtypes.xml @@ -0,0 +1,71 @@ + + + + + Base types and constants + + 2D point object + + + Initialize the point object + + + Rectangle object + + + X position of top left point + + + Y position of top left point + + + Width of rectangle + + + Height of rectangle + + + An enum to identify the left mouse button + + + An enum to identify the middle mouse button + + + An enum to identify the right mouse button + + + Group record + + + anchor point + width and height of the region + + + group behavior + + + border + + + interior + + + X location + + + Y location + + + Constructor for the object + + + Constructor for the object + + + Helper function to initialize the point object + + + Helper function to initialize the object + + + + diff --git a/components/nvidia-widgets/doc/nvwidgets.xml b/components/nvidia-widgets/doc/nvwidgets.xml deleted file mode 100644 index 41c3e2052..000000000 --- a/components/nvidia-widgets/doc/nvwidgets.xml +++ /dev/null @@ -1,337 +0,0 @@ - - - - - - 2D point object - - - Initialize the point object - - - Rectangle object - - - X position of top left point - - - Y position of top left point - - - Width of rectangle - - - Height of rectangle - - - An enum to identify the left mouse button - - - An enum to identify the middle mouse button - - - An enum to identify the right mouse button - - - UI method for processing window size events - - - Check if the UI is currently on Focus - - - UI method for processing mouse events - - - Group record - - - anchor point + width and height of the region - - - group behavior - - - border - - - interior - - - UI method for processing mouse motion events - - - UI method for processing key events - - - UI method for entering UI processing mode - This function must be used to begin the UI processing - - - UI method for leaving UI processing mode - This function must be used to end the UI processing - - - UI method for drawing a static text label - -

The label displays a non interactive text.

-

The style flag enables to draw the label in two distinct styles. The first one is default (style = 0) and displays the label simply as text. The alternative (style = 1) displays the label with a frame around it. An example is shown in the following figure.

- -

The Text variable can have multiple lines.

-

Example code how to implement a label

- none.Rect(0, 0); -ui.beginGroup(GroupFlags_GrowDownFromRight); - ui.doLabel(none, Text); -ui.endGroup; - -
-
- - optionally provides a location and size for the label - - - Text to display for the label (can have several lines) - - - optional style flag to modify the look - - - UI method for rendering and processing a push button - -

The button method does only take a text and state variable. This variable is modified if the button is pressed or depressed. When a state change occurs the method function returns True.

- -

Example code how to implement a button

- none.Rect(0, 0); -ui.beginGroup(GroupFlags_GrowDownFromRight); - if ui.doButton(none, 'Apply') then - begin - //code to apply your changes - end; -ui.endGroup; - -
-
- - optionally provides a location and size for the button - - - text to display on the button - - - whether the button is depressed - if state is NULL; the button behave like a touch button else; the button behave like a toggle button - - - optional style flag to modify the look - - - UI method for rendering and processing a check button - -

Check button behaves similarly as a toggle button used to display and edit a boolean property.

- -
-
- - optionally provides a location and size for the button - - - text to display on the button - - - whether the check button is checked or not - if state is NULL; the button behave like if a touch button unchecked - - - optional style flag to modify the look - - - UI method for rendering and processing a radio button - -

Radio buttons are typically used in groups to display and edit the possible reference values taken by an integer value. -

-

One radio button is representing a possible reference value taken by the current value. -It is displaying a boolean state true if the current value is equal to the reference value.

- -
-
- - The reference int value represented by this radio button. - - - optionally provides a location and size for the button - - - text to display on the button - - - The value parameter compared to the reference value parameter. - if value is NULL; the radio button is off - - - optional style flag to modify the look - - - True if the radio button value changed - - - True if the check button state changed - - - UI method for rendering and processing a horizontal slider - -

Horizontal slider is used to edit and display a scalar value in the specified range [min; max].

- -
-
- - optionally provides a location and size for the widget - - - min bound of the varying range of the value - - - max bound of the varying range of the value - - - the value edited by the widget - if value is NULL; the value is set to min - - - optional style flag to modify the look - - - True if the slider value changed - - - UI method for drawing a texture view - -

Several parameters control the equation used to display the texel

- texel = texture2DFetch(...); -pixel = texelSwizzling( texel * texelScale + texelOffset ); - - -
-
- - provides a location and size for the texture view - - - texture identifier (Graphics API specific) - - - rectangle area of the texture displayed - - - mip Level of the texture displayed - - - scale applyed to the texel fetch - - - offset applyed to the texel after scale - - - optional style flag to modify the look - - - X location - - - Y location - - - Active widget painter - - - Boolean evaluation function - -

This function evaluates a boolean to a numerical value.

-

True equals 1 -False equals 0

-
-
- - Constructor for the object - - - Constructor for the object - - - Helper function to initialize the point object - - - Helper function to initialize the object - - - Basic UI context - - - Basic painter class - - - Begin grouping section of UI objects - - User Interface library - - List item widget - - - - - - Listbox widget - - - - - - Combobox widget - - - - - - Line edit widget - - - - - - Frame positioning section - - - - - - Frame positioning widget - - - - - - Panel positioning widget - - - - - - Panel positioning widget - - - - -
- NVIDIA widget library - -

This library is originally based on the NVIDIA widget library. NVIDIA Widgets is the -immediate mode graphical user interface toolkit used by the -NVIDIA SDK samples. -

-

Originally ported to FPC by Darius Blaszyk in June 2011.

-

This library is distributed under the MIT license, as the original library was.

-

The original code can be found here: -

- -

For more information see the Lazarus wiki.

-
-
-