initial import of documentation
git-svn-id: https://svn.code.sf.net/p/lazarus-ccr/svn@2208 8e941d3f-bd1b-0410-a28a-d453659cc2b4
This commit is contained in:
blaszijk
parent
4f0e632b73
commit
07805fc51a
31
components/nvidia-widgets/doc/nvglutwidgets.xml
Normal file
31
components/nvidia-widgets/doc/nvglutwidgets.xml
Normal file
@ -0,0 +1,31 @@
|
||||
<?xml version="1.0"?>
|
||||
<fpdoc-descriptions>
|
||||
<package name="nvidia widgets">
|
||||
<module name="nvGLutWidgets">
|
||||
<element name="GlutUIContext.translateKey">
|
||||
<short>Translate non-ascii keys from GLUT to nvWidgets</short>
|
||||
</element>
|
||||
<element name="GlutUIContext.specialKeyboard">
|
||||
<short>UI method for processing key events</short>
|
||||
<descr>Call this method from the glutReshapeFunc callback</descr>
|
||||
</element>
|
||||
<element name="GlutUIContext.mouse">
|
||||
<short>UI method for processing GLUT mouse button events</short>
|
||||
<descr>Call this method from the glutMouseFunc callback, the modifier parameter maps to glutGetModifiers.</descr>
|
||||
</element>
|
||||
<element name="GlutUIContext.init">
|
||||
<short>One time initialization</short>
|
||||
</element>
|
||||
<element name="GlutUIContext.Destroy">
|
||||
<short>UI destructor</short>
|
||||
</element>
|
||||
<element name="GlutUIContext.Create">
|
||||
<short>UI constructor</short>
|
||||
<descr>Allows for overriding the standard painter</descr>
|
||||
</element>
|
||||
<element name="GlutUIContext.m_ownPainter">
|
||||
<short>Variable indicating a default painter object</short>
|
||||
</element>
|
||||
</module>
|
||||
</package>
|
||||
</fpdoc-descriptions>
|
||||
8
components/nvidia-widgets/doc/nvglwidgets.xml
Normal file
8
components/nvidia-widgets/doc/nvglwidgets.xml
Normal file
@ -0,0 +1,8 @@
|
||||
<?xml version="1.0"?>
|
||||
<fpdoc-descriptions>
|
||||
<package name="nvidia widgets">
|
||||
<module name="nvWidgets">
|
||||
|
||||
</module>
|
||||
</package>
|
||||
</fpdoc-descriptions>
|
||||
8
components/nvidia-widgets/doc/nvshaderutils.xml
Normal file
8
components/nvidia-widgets/doc/nvshaderutils.xml
Normal file
@ -0,0 +1,8 @@
|
||||
<?xml version="1.0"?>
|
||||
<fpdoc-descriptions>
|
||||
<package name="nvidia widgets">
|
||||
<module name="nvShaderUtils">
|
||||
|
||||
</module>
|
||||
</package>
|
||||
</fpdoc-descriptions>
|
||||
124
components/nvidia-widgets/doc/nvwidgets.xml
Normal file
124
components/nvidia-widgets/doc/nvwidgets.xml
Normal file
@ -0,0 +1,124 @@
|
||||
<?xml version="1.0"?>
|
||||
<fpdoc-descriptions>
|
||||
<package name="nvidia widgets">
|
||||
<module name="nvWidgets">
|
||||
<short/>
|
||||
<descr/>
|
||||
<element name="Point">
|
||||
<short>2D point object</short>
|
||||
</element>
|
||||
<element name="SetPoint.Result">
|
||||
<short>Initialize the point object</short>
|
||||
</element>
|
||||
<element name="Rect">
|
||||
<short>Rectangle object</short>
|
||||
</element>
|
||||
<element name="Rect.x">
|
||||
<short>X position of top left point</short>
|
||||
</element>
|
||||
<element name="Rect.y">
|
||||
<short>Y position of top left point</short>
|
||||
</element>
|
||||
<element name="Rect.w">
|
||||
<short>Width of rectangle</short>
|
||||
</element>
|
||||
<element name="Rect.h">
|
||||
<short>Height of rectangle</short>
|
||||
</element>
|
||||
<element name="MouseButton_Left">
|
||||
<short>An enum to identify the left mouse button</short>
|
||||
</element>
|
||||
<element name="MouseButton_Middle">
|
||||
<short>An enum to identify the middle mouse button</short>
|
||||
</element>
|
||||
<element name="MouseButton_Right">
|
||||
<short>An enum to identify the right mouse button</short>
|
||||
</element>
|
||||
<element name="UIContext.reshape">
|
||||
<short>UI method for processing window size events</short>
|
||||
</element>
|
||||
<element name="UIContext.isOnFocus">
|
||||
<short>Check if the UI is currently on Focus</short>
|
||||
</element>
|
||||
<element name="UIContext.mouse">
|
||||
<short>UI method for processing mouse events</short>
|
||||
</element>
|
||||
<element name="Group">
|
||||
<short>Group record</short>
|
||||
</element>
|
||||
<element name="Group.bounds">
|
||||
<short>anchor point + width and height of the region </short>
|
||||
</element>
|
||||
<element name="Group.flags">
|
||||
<short>group behavior</short>
|
||||
</element>
|
||||
<element name="Group.margin">
|
||||
<short>border</short>
|
||||
</element>
|
||||
<element name="Group.space">
|
||||
<short>interior</short>
|
||||
</element>
|
||||
<element name="UIContext.mouseMotion">
|
||||
<short>UI method for processing mouse motion events</short>
|
||||
</element>
|
||||
<element name="UIContext.keyboard">
|
||||
<short>UI method for processing key events</short>
|
||||
</element>
|
||||
<element name="UIContext._begin">
|
||||
<short>UI method for entering UI processing mode</short>
|
||||
<descr>This function must be used to begin the UI processing </descr>
|
||||
</element>
|
||||
<element name="UIContext._end">
|
||||
<short>UI method for leaving UI processing mode</short>
|
||||
<descr>This function must be used to end the UI processing</descr>
|
||||
</element>
|
||||
<element name="UIContext.doLabel">
|
||||
<short>UI method for drawing a static text label</short>
|
||||
<descr>The label display a non interactive text.
|
||||
The text can have multiple lines</descr>
|
||||
</element>
|
||||
<element name="UIContext.doLabel.r">
|
||||
<short>optionally provides a location and size for the label</short>
|
||||
</element>
|
||||
<element name="UIContext.doLabel.Text">
|
||||
<short>Text to display for the label (can have several lines)</short>
|
||||
</element>
|
||||
<element name="UIContext.doLabel.style">
|
||||
<short>optional style flag to modify the look</short>
|
||||
</element>
|
||||
<element name="UIContext.doButton">
|
||||
<short>UI method for rendering and processing a push button</short>
|
||||
</element>
|
||||
<element name="UIContext.doButton.r">
|
||||
<short>optionally provides a location and size for the button</short>
|
||||
</element>
|
||||
<element name="UIContext.doButton.Text">
|
||||
<short>text to display on the button</short>
|
||||
</element>
|
||||
<element name="UIContext.doButton.state">
|
||||
<short>whether the button is depressed</short>
|
||||
<descr>if state is NULL; the button behave like a touch button else; the button behave like a toggle button</descr>
|
||||
</element>
|
||||
<element name="UIContext.doButton.style">
|
||||
<short>optional style flag to modify the look</short>
|
||||
</element>
|
||||
<element name="UIContext.doCheckButton">
|
||||
<short>UI method for rendering and processing a check button</short>
|
||||
<descr>Check button behaves similarly as a toggle button used to display and edit a bool property. </descr>
|
||||
</element>
|
||||
<element name="UIContext.doCheckButton.r">
|
||||
<short>optionally provides a location and size for the button</short>
|
||||
</element>
|
||||
<element name="UIContext.doCheckButton.Text">
|
||||
<short>text to display on the button</short>
|
||||
</element>
|
||||
<element name="UIContext.doCheckButton.state">
|
||||
<short>whether the check button is checked or not</short>
|
||||
<descr>if state is NULL; the buttoin behave like if a touch button unchecked</descr>
|
||||
</element>
|
||||
<element name="UIContext.doCheckButton.style">
|
||||
<short>optional style flag to modify the look</short>
|
||||
</element>
|
||||
</module>
|
||||
</package>
|
||||
</fpdoc-descriptions>
|
||||
Loading…
Reference in New Issue
Block a user