Expand description
§Rust bindings for the X-Plane SDK
Low level Rust bindings for the X-Plane SDK.
§Features
- Includes pre-built bindings for version
XPLM400
(X-Plane 12.04 and newer) - Option to generate bindings at compile-time, using your own SDK version
- Allows for precise version specification when using compile-time generated bindings
§Generate your own bindings
To generate your own bindings instead of using the pre-built ones, activate the generate-bindings
feature by adding
the following to your Cargo.toml
:
xplane-sdk-sys = { version = "*", features = ["generate-bindings"] }
This will invoke bindgen
at compile-time in a build script to generate the bindings for you. You must specify the
location of the SDK in your filesystem by setting the XPLANE_SDK_PATH
environment variable.
§Requirements
xplane-sdk-sys
inherits the bindgen
requirements. They are
documented here.
§SDK version selection
When generating bindings yourself you can specify what XPLM versions you would like to use. This not only enables you to target earlier X-Plane versions but also ensures that the library is compatible with future versions.
To achieve this, you need to set the XPLANE_SDK_VERSIONS
environment variable. It expects a semicolon-separated list
of SDK versions. Defining at as XPLM303;XPLM400
, for example, will result in the generation of bindings for SDK
versions 3.0.3
and 4.0.0
respectively.
Please note that SDK versions do not automatically imply older versions. To ensure that the latest version with all features is targeted, it is necessary to specify every version individually.
If you leave the XPLANE_SDK_VERSIONS
environment variable unspecified, the default set of versions used for generating
the pre-built binding will be applied.
§Changelog
§Version 0.3
- Include XPLM400 in pre-built bindings
- Update SDK version to 4.0.1
§Version 0.2
- Update SDK version to 4.0.0
- Switch from cargo feature based version selection to environment variable definitions
§Version 0.1
- Initial release with pre-built or compile time generated bindings
Structs§
- FMOD_
VECTOR - XPKey
State_ t - XPKeyState_t
- XPLM
Camera Position_ t - XPLMCameraPosition_t
- XPLM
Create Flight Loop_ t - XPLMCreateFlightLoop_t
- XPLM
Create MapLayer_ t - XPLMCreateMapLayer_t
- XPLM
Create Window_ t - XPLMCreateWindow_t
- XPLM
Customize Avionics_ t - XPLMCustomizeAvionics_t
- XPLM
Data RefInfo_ t - XPLMDataRefInfo_t
- XPLM
Draw Info_ t - XPLMDrawInfo_t
- XPLM
Fixed String150_ t - XPLMFixedString150_t
- XPLM
Probe Info_ t - XPLMProbeInfo_t
- XPLM
Weather Info Clouds_ t - XPLMWeatherInfoClouds_t
- XPLM
Weather Info Winds_ t - XPLMWeatherInfoWinds_t
- XPLM
Weather Info_ t - XPLMWeatherInfo_t
- XPMouse
State_ t - XPMouseState_t
- XPWidget
Create_ t - XPWidgetCreate_t
- XPWidget
Geometry Change_ t - XPWidgetGeometryChange_t
Constants§
- FMOD_
RESULT_ FMOD_ OK - FMOD_
SOUND_ FORMAT_ FMOD_ SOUND_ FORMAT_ PCM16 - NO_
PARENT - PARAM_
PARENT - WCHAR_
MAX - WCHAR_
MIN - WINT_
MAX - WINT_
MIN - XPLM_
KEY_ 0 - XPLM_
KEY_ 1 - XPLM_
KEY_ 2 - XPLM_
KEY_ 3 - XPLM_
KEY_ 4 - XPLM_
KEY_ 5 - XPLM_
KEY_ 6 - XPLM_
KEY_ 7 - XPLM_
KEY_ 8 - XPLM_
KEY_ 9 - XPLM_
KEY_ DECIMAL - XPLM_
KEY_ DELETE - XPLM_
KEY_ DOWN - XPLM_
KEY_ ESCAPE - XPLM_
KEY_ LEFT - XPLM_
KEY_ RETURN - XPLM_
KEY_ RIGHT - XPLM_
KEY_ TAB - XPLM_
KEY_ UP - XPLM_
MAP_ IOS - XPLM_
MAP_ USER_ INTERFACE - XPLM_
MSG_ AIRPLANE_ COUNT_ CHANGED - XPLM_
MSG_ AIRPORT_ LOADED - XPLM_
MSG_ DATAREFS_ ADDED - XPLM_
MSG_ ENTERED_ VR - XPLM_
MSG_ EXITING_ VR - XPLM_
MSG_ FMOD_ BANK_ LOADED - XPLM_
MSG_ FMOD_ BANK_ UNLOADING - XPLM_
MSG_ LIVERY_ LOADED - XPLM_
MSG_ PLANE_ CRASHED - XPLM_
MSG_ PLANE_ LOADED - XPLM_
MSG_ PLANE_ UNLOADED - XPLM_
MSG_ RELEASE_ PLANES - XPLM_
MSG_ SCENERY_ LOADED - XPLM_
MSG_ WILL_ WRITE_ PREFS - XPLM_
NAV_ NOT_ FOUND - XPLM_
NO_ PLUGIN_ ID - XPLM_
PLUGIN_ XPLANE - XPLM_
USER_ AIRCRAFT - XPLM_
VK_ 0 - XPLM_
VK_ 1 - XPLM_
VK_ 2 - XPLM_
VK_ 3 - XPLM_
VK_ 4 - XPLM_
VK_ 5 - XPLM_
VK_ 6 - XPLM_
VK_ 7 - XPLM_
VK_ 8 - XPLM_
VK_ 9 - XPLM_
VK_ A - XPLM_
VK_ ADD - XPLM_
VK_ B - XPLM_
VK_ BACK - XPLM_
VK_ BACKQUOTE - XPLM_
VK_ BACKSLASH - XPLM_
VK_ C - XPLM_
VK_ CLEAR - XPLM_
VK_ COMMA - XPLM_
VK_ D - XPLM_
VK_ DECIMAL - XPLM_
VK_ DELETE - XPLM_
VK_ DIVIDE - XPLM_
VK_ DOWN - XPLM_
VK_ E - XPLM_
VK_ END - XPLM_
VK_ ENTER - XPLM_
VK_ EQUAL - XPLM_
VK_ ESCAPE - XPLM_
VK_ EXECUTE - XPLM_
VK_ F - XPLM_
VK_ F1 - XPLM_
VK_ F2 - XPLM_
VK_ F3 - XPLM_
VK_ F4 - XPLM_
VK_ F5 - XPLM_
VK_ F6 - XPLM_
VK_ F7 - XPLM_
VK_ F8 - XPLM_
VK_ F9 - XPLM_
VK_ F10 - XPLM_
VK_ F11 - XPLM_
VK_ F12 - XPLM_
VK_ F13 - XPLM_
VK_ F14 - XPLM_
VK_ F15 - XPLM_
VK_ F16 - XPLM_
VK_ F17 - XPLM_
VK_ F18 - XPLM_
VK_ F19 - XPLM_
VK_ F20 - XPLM_
VK_ F21 - XPLM_
VK_ F22 - XPLM_
VK_ F23 - XPLM_
VK_ F24 - XPLM_
VK_ G - XPLM_
VK_ H - XPLM_
VK_ HELP - XPLM_
VK_ HOME - XPLM_
VK_ I - XPLM_
VK_ INSERT - XPLM_
VK_ J - XPLM_
VK_ K - XPLM_
VK_ L - XPLM_
VK_ LBRACE - XPLM_
VK_ LEFT - XPLM_
VK_ M - XPLM_
VK_ MINUS - XPLM_
VK_ MULTIPLY - XPLM_
VK_ N - XPLM_
VK_ NEXT - XPLM_
VK_ NUMPA D0 - XPLM_
VK_ NUMPA D1 - XPLM_
VK_ NUMPA D2 - XPLM_
VK_ NUMPA D3 - XPLM_
VK_ NUMPA D4 - XPLM_
VK_ NUMPA D5 - XPLM_
VK_ NUMPA D6 - XPLM_
VK_ NUMPA D7 - XPLM_
VK_ NUMPA D8 - XPLM_
VK_ NUMPA D9 - XPLM_
VK_ NUMPAD_ ENT - XPLM_
VK_ NUMPAD_ EQ - XPLM_
VK_ O - XPLM_
VK_ P - XPLM_
VK_ PERIOD - XPLM_
VK_ PRINT - XPLM_
VK_ PRIOR - XPLM_
VK_ Q - XPLM_
VK_ QUOTE - XPLM_
VK_ R - XPLM_
VK_ RBRACE - XPLM_
VK_ RETURN - XPLM_
VK_ RIGHT - XPLM_
VK_ S - XPLM_
VK_ SELECT - XPLM_
VK_ SEMICOLON - XPLM_
VK_ SEPARATOR - XPLM_
VK_ SLASH - XPLM_
VK_ SNAPSHOT - XPLM_
VK_ SPACE - XPLM_
VK_ SUBTRACT - XPLM_
VK_ T - XPLM_
VK_ TAB - XPLM_
VK_ U - XPLM_
VK_ UP - XPLM_
VK_ V - XPLM_
VK_ W - XPLM_
VK_ X - XPLM_
VK_ Y - XPLM_
VK_ Z - _CRT_
PACKING - _HAS_
CXX17 - _HAS_
CXX20 - _HAS_
CXX23 - _HAS_
EXCEPTIONS - _HAS_
NODISCARD - _SAL_
VERSION - _STL_
LANG - _USE_
ATTRIBUTES_ FOR_ SAL - _USE_
DECLSPECS_ FOR_ SAL - _VCRT_
COMPILER_ PREPROCESSOR - __
SAL_ H_ VERSION - kXPLM_
Version - xpAircraft
Carrier - xpBuilding
- xpButton
Behavior Check Box - Check box behavior. The button immediately toggles its value when the mouse* is clicked and sends out a xpMsg_ButtonStateChanged message.
- xpButton
Behavior Push Button - Standard push button behavior. The button highlights while the mouse is * clicked over it and unhighlights when the mouse is moved outside of it or * released. If the mouse is released over the button, the * xpMsg_PushButtonPressed message is sent.
- xpButton
Behavior Radio Button - Radio button behavior. The button immediately sets its state to one and * sends out a xpMsg_ButtonStateChanged message if it was not already set to * one. You must turn off other radio buttons in a group in your code.
- xpCooling
Tower - xpCustom
Object - xpElement_
Aircraft Carrier - none any
- xpElement_
Airport - none any
- xpElement_
Building - none any
- xpElement_
Check Box - none metal
- xpElement_
Check BoxLit - none metal
- xpElement_
Cooling Tower - none any
- xpElement_
Copy Buttons - none metal
- xpElement_
Copy Buttons With Editing Grid - none metal
- xpElement_
Custom Object - none any
- xpElement_
Editing Grid - x, y metal
- xpElement_
Fire - none any
- xpElement_
ILSGlide Scope - none any
- xpElement_
Little Down Arrow - none metal
- xpElement_
Little UpArrow - none metal
- xpElement_
Marker Left - none any
- xpElement_
Marker Right - none any
- xpElement_
NDB - none any
- xpElement_
OilPlatform - none any
- xpElement_
OilPlatform Small - none any
- xpElement_
Power Line - none any
- xpElement_
Push Button - x metal
- xpElement_
Push Button Lit - x metal
- xpElement_
Radio Tower - none any
- xpElement_
Scroll Bar - THIS CAN PROBABLY BE REMOVED
- xpElement_
Ship - none any
- xpElement_
Smoke Stack - none any
- xpElement_
Text Field - x metal
- xpElement_
Text Field Middle - x, y metal
- xpElement_
VOR - none any
- xpElement_
VORWith Compass Rose - none any
- xpElement_
Waypoint - none any
- xpElement_
Window Close Box - none window header
- xpElement_
Window Close BoxPressed - none window header
- xpElement_
Window Drag Bar - none metal
- xpElement_
Window Drag BarSmooth - none metal
- xpElement_
Zoomer - none metal
- xpFire
- xpILS
Glide Scope - xpLittle
Down Arrow - A small down arrow.
- xpLittle
UpArrow - A small up arrow.
- xpMain
Window Style_ Main Window - The standard main window; pin stripes on XP7, metal frame on XP 6.
- xpMain
Window Style_ Translucent - A translucent dark gray window.
- xpMarker
Left - xpMarker
Right - xpMessage_
Close Button Pushed - This message is sent when the close buttons for your window are pressed.
- xpMode_
Direct - The message will only be sent to the target widget.
- xpMode_
Direct AllCallbacks - The message is sent just to the target, but goes to every callback, even if* it is handled.
- xpMode_
Once - The message is only sent to the very first handler even if it is not * accepted. (This is really only useful for some internal widget library * functions.)
- xpMode_
Recursive - The message is sent to the target widget and then all of its children * recursively depth-first.
- xpMode_
UpChain - The message is sent to the target widget, then up the chain of parents * until the message is handled or a parentless widget is reached.
- xpMsg_
Accept Child - A child has been added to you. The child’s ID is passed in parameter one. * * Dispatching: Direct * * Param 1: The Widget ID of the child being added.
- xpMsg_
Accept Parent - You now have a new parent, or have no parent. The parent’s ID is passed in,* or 0 for no parent. * * Dispatching: Direct * * Param 1: The Widget ID of your parent
- xpMsg_
Button State Changed - This message is sent when a button is clicked that has radio button or * check box behavior and its value changes. (Note that if the value changes * by setting a property you do not receive this message!) Parameter one is * the widget ID of the button, parameter 2 is the new state value, either * zero or one. This message is dispatched up the widget hierarchy.
- xpMsg_
Create - The create message is sent once per widget that is created with your widget* function and once for any widget that has your widget function attached. * * Dispatching: Direct * * Param 1: 1 if you are being added as a subclass, 0 if the widget is first * being created.
- xpMsg_
Cursor Adjust - The cursor is over your widget. If you consume this message, change the * XPLMCursorStatus value to indicate the desired result, with the same rules * as in XPLMDisplay.h. * * Return 1 to consume this message, 0 to pass it on. * * Dispatching: Up chain Param 1: A pointer to an XPMouseState_t struct * containing the mouse status. * * Param 2: A pointer to a XPLMCursorStatus - set this to the cursor result * you desire.
- xpMsg_
Descriptor Changed - Your descriptor has changed. * * Dispatching: Direct
- xpMsg_
Destroy - The destroy message is sent once for each message that is destroyed that * has your widget function. * * Dispatching: Direct for all * * Param 1: 1 if being deleted by a recursive delete to the parent, 0 for * explicit deletion.
- xpMsg_
Draw - The draw message is sent to your widget when it is time to draw yourself. * OpenGL will be set up to draw in 2-d global screen coordinates, but you * should use the XPLM to set up OpenGL state. * * Dispatching: Direct
- xpMsg_
Exposed Changed - Your exposed area has changed. * * Dispatching: Direct
- xpMsg_
Hidden - You have been hidden. See limitations above. * * Dispatching: Up chain * * Param 1: The widget ID of the hidden widget.
- xpMsg_
KeyLose Focus - Keyboard focus is being taken away from you. The first parameter will be 1 * if you are losing focus because another widget is taking it, or 0 if * someone called the API to make you lose focus explicitly. * * Dispatching: Direct * * Param 1: 1 if focus is being taken by another widget, 0 if code requested * to remove focus.
- xpMsg_
KeyPress - The key press message is sent once per key that is pressed. The first * parameter is the type of key code (integer or char) and the second is the * code itself. By handling this event, you consume the key stroke. * * Handling this message ‘consumes’ the keystroke; not handling it passes it * to your parent widget. * * Dispatching: Up Chain * * Param 1: A pointer to an XPKeyState_t structure with the keystroke.
- xpMsg_
KeyTake Focus - Keyboard focus is being given to you. By handling this message you accept * keyboard focus. The first parameter will be one if a child of yours gave up* focus to you, 0 if someone set focus on you explicitly. * * Handling this message accepts focus; not handling refuses focus. * * Dispatching: direct * * Param 1: 1 if you are gaining focus because your child is giving it up, 0 * if someone is explicitly giving you focus.
- xpMsg_
Lose Child - A child has been removed from you. The child’s ID is passed in parameter * one. * * Dispatching: Direct * * Param 1: The Widget ID of the child being removed.
- xpMsg_
Mouse Down - You receive one mousedown event per click with a mouse-state structure * pointed to by parameter 1. By accepting this you eat the click, otherwise * your parent gets it. You will not receive drag and mouse up messages if you* do not accept the down message. * * Handling this message consumes the mouse click, not handling it passes it * to the next widget. You can act ‘transparent’ as a window by never handling* moues clicks to certain areas. * * Dispatching: Up chain NOTE: Technically this is direct dispatched, but the * widgets library will ship it to each widget until one consumes the click, * making it effectively “up chain”. * * Param 1: A pointer to an XPMouseState_t containing the mouse status.
- xpMsg_
Mouse Drag - You receive a series of mouse drag messages (typically one per frame in the* sim) as the mouse is moved once you have accepted a mouse down message. * Parameter one points to a mouse-state structure describing the mouse * location. You will continue to receive these until the mouse button is * released. You may receive multiple mouse state messages with the same mouse* position. You will receive mouse drag events even if the mouse is dragged * out of your current or original bounds at the time of the mouse down. * * Dispatching: Direct * * Param 1: A pointer to an XPMouseState_t containing the mouse status.
- xpMsg_
Mouse Up - The mouseup event is sent once when the mouse button is released after a * drag or click. You only receive this message if you accept the mouseDown * message. Parameter one points to a mouse state structure. * * Dispatching: Direct * * Param 1: A pointer to an XPMouseState_t containing the mouse status.
- xpMsg_
Mouse Wheel - The mouse wheel has moved. * * Return 1 to consume the mouse wheel move, or 0 to pass the message to a * parent. Dispatching: Up chain * * Param 1: A pointer to an XPMouseState_t containing the mouse status.
- xpMsg_
None - No message, should not be sent.
- xpMsg_
Paint - The paint message is sent to your widget to draw itself. The paint message * is the bare-bones message; in response you must draw yourself, draw your * children, set up clipping and culling, check for visibility, etc. If you * don’t want to do all of this, ignore the paint message and a draw message * (see below) will be sent to you. * * Dispatching: Direct
- xpMsg_
Property Changed - A property has changed. Param 1 contains the property ID. * * Dispatching: Direct * * Param 1: The Property ID being changed. * * Param 2: The new property value
- xpMsg_
Push Button Pressed - This message is sent when the user completes a click and release in a * button with push button behavior. Parameter one of the message is the * widget ID of the button. This message is dispatched up the widget * hierarchy.
- xpMsg_
Reshape - Your geometry or a child’s geometry is being changed. * * Dispatching: Up chain * * Param 1: The widget ID of the original reshaped target. * * Param 2: A pointer to a XPWidgetGeometryChange_t struct describing the * change.
- xpMsg_
Scroll BarSlider Position Changed - The scroll bar sends this message when the slider position changes. It * sends the message up the call chain; param1 is the scroll bar widget ID.
- xpMsg_
Shown - You or a child has been shown. Note that this does not include you being * shown because your parent was shown, you were put in a new parent, your * root was shown, etc. * * Dispatching: Up chain * * Param 1: The widget ID of the shown widget.
- xpMsg_
Text Field Changed - The text field sends this message to itself when its text changes. It sends* the message up the call chain; param1 is the text field’s widget ID.
- xpMsg_
User Start - NOTE: Message IDs 1000 - 9999 are allocated to the standard widget classes * provided with the library with 1000 - 1099 for widget class 0, 1100 - 1199 * for widget class 1, etc. Message IDs 10,000 and beyond are for plugin use.
- xpNDB
- xpOil
Platform - xpOil
Platform Small - xpPower
Line - xpProperty_
Active Edit Side - This is the active side of the insert selection. (Internal)
- xpProperty_
Button Behavior - This property sets the button’s behavior. Use one of the button behaviors * above.
- xpProperty_
Button State - This property tells whether a check box or radio button is “checked” or * not. Not used for push buttons.
- xpProperty_
Button Type - This property sets the visual type of button. Use one of the button types * above.
- xpProperty_
Caption Lit - This property specifies whether the caption is lit; use lit captions * against screens.
- xpProperty_
Clip - If this property is 1, the widget package will use OpenGL to restrict * drawing to the Widget’s exposed rectangle.
- xpProperty_
DragX Off - These properties are used by the utilities to implement dragging.
- xpProperty_
DragY Off - These properties are used by the utilities to implement dragging.
- xpProperty_
Dragging - These properties are used by the utilities to implement dragging.
- xpProperty_
Edit Field SelDrag Start - This is the character position a drag was started at if the user is * dragging to select text, or -1 if a drag is not in progress.
- xpProperty_
Edit Field SelEnd - This is the character position of the end of the selection.
- xpProperty_
Edit Field SelStart - This is the character position the selection starts at, zero based. If it * is the same as the end insertion point, the insertion point is not a * selection.
- xpProperty_
Enabled - Is this widget enabled (for those that have a disabled state too)?
- xpProperty_
Font - The font to draw the field’s text with. (An XPLMFontID.)
- xpProperty_
General Graphics Type - This property controls the type of icon that is drawn.
- xpProperty_
Hilited - Is the widget highlighted? (For widgets that support this kind of thing.)
- xpProperty_
Main Window HasClose Boxes - This property specifies whether the main window has close boxes in its * corners.
- xpProperty_
Main Window Type - This property specifies the type of window. Set to one of the main window * types above.
- xpProperty_
MaxCharacters - The max number of characters you can enter, if limited. Zero means * unlimited.
- xpProperty_
Object - Is there a C++ object attached to this widget?
- xpProperty_
Password Mode - Set this property to 1 to password protect the field. Characters will be * drawn as *s even though the descriptor will contain plain-text.
- xpProperty_
Progress Max - This is the maximum value, equivalent to 100% filled.
- xpProperty_
Progress Min - This is the minimum value, equivalent to 0% filled.
- xpProperty_
Progress Position - This is the current value of the progress indicator.
- xpProperty_
Refcon - A window’s refcon is an opaque value used by client code to find other data* based on it.
- xpProperty_
Scroll BarMax - The value the scroll bar has when the thumb is in the highest position.
- xpProperty_
Scroll BarMin - The value the scroll bar has when the thumb is in the lowest position.
- xpProperty_
Scroll BarPage Amount - How many units to move the scroll bar when clicking next to the thumb. The * scroll bar always moves one unit when the arrows are clicked.
- xpProperty_
Scroll BarSlider Position - The current position of the thumb (in between the min and max, inclusive)
- xpProperty_
Scroll BarSlop - Used internally.
- xpProperty_
Scroll BarType - The type of scrollbar from the enums above.
- xpProperty_
Scroll Position - The first visible character on the left. This effectively scrolls the text* field.
- xpProperty_
SubWindow Type - This property specifies the type of window. Set to one of the subwindow * types above.
- xpProperty_
Text Field Type - This is the type of text field to display, from the above list.
- xpProperty_
User Start - NOTE: Property IDs 1 - 999 are reserved for the widgets library. * * NOTE: Property IDs 1000 - 9999 are allocated to the standard widget classes* provided with the library. * * Properties 1000 - 1099 are for widget class 0, 1100 - 1199 for widget class* 1, etc.
- xpPush
Button - This is a standard push button, like an ‘OK’ or ‘Cancel’ button in a dialog* box.
- xpRadio
Button - A check box or radio button. Use this and the button behaviors below to * get the desired behavior.
- xpRadio
Tower - xpScroll
BarType Scroll Bar - A standard X-Plane scroll bar (with arrows on the ends).
- xpScroll
BarType Slider - A slider, no arrows.
- xpShip
- xpSmoke
Stack - xpSub
Window Style_ List View - A list view for scrolling lists.
- xpSub
Window Style_ Screen - A screen that sits inside a panel for showing text information.
- xpSub
Window Style_ SubWindow - A panel that sits inside a main window.
- xpText
Entry Field - A field for text entry.
- xpText
Translucent - A translucent edit field, dark gray.
- xpText
Transparent - A transparent text field. The user can type and the text is drawn, but no * background is drawn. You can draw your own background by adding a widget * handler and prehandling the draw message.
- xpTrack_
Progress - over metal cannot be lit cannot be rotated
- xpTrack_
Scroll Bar - not over metal can be lit can be rotated
- xpTrack_
Slider - over metal can be lit can be rotated
- xpVOR
- xpVOR
With Compass Rose - xpWay
Point - xpWidget
Class_ Button - xpWidget
Class_ Caption - xpWidget
Class_ General Graphics - xpWidget
Class_ Main Window - xpWidget
Class_ None - xpWidget
Class_ Progress - xpWidget
Class_ Scroll Bar - xpWidget
Class_ SubWindow - xpWidget
Class_ Text Field - xpWindow
Close Box - A window close box.
- xpWindow_
Help - An LCD screen that shows help.
- xpWindow_
List View - A list view within a panel for scrolling file names, etc.
- xpWindow_
Main Window - A dialog box window.
- xpWindow_
Screen - An LCD screen within a panel to hold text displays.
- xpWindow_
SubWindow - A panel or frame within a dialog box window.
- xp_
Airport - xplm
Font_ Basic - Mono-spaced font for user interface. Available in all versions of the SDK.
- xplm
Font_ Proportional - Proportional UI font.
- xplm
Type_ Data - A variable block of data.
- xplm
Type_ Double - A single 8-byte double, native endian.
- xplm
Type_ Float - A single 4-byte float, native endian.
- xplm
Type_ Float Array - An array of 4-byte floats, native endian.
- xplm
Type_ Int - A single 4-byte integer, native endian.
- xplm
Type_ IntArray - An array of 4-byte integers, native endian.
- xplm
Type_ Unknown - Data of a type the current XPLM doesn’t do.
- xplm_
Audio Exterior Aircraft - Copilot’s own speech
- xplm_
Audio Exterior Environment - Copilot’s own speech
- xplm_
Audio Exterior Unprocessed - Copilot’s own speech
- xplm_
Audio Ground - Dedicated ground vehicle cable
- xplm_
Audio Interior - Copilot’s own speech
- xplm_
Audio Radio Com1 - Incoming speech on COM1
- xplm_
Audio Radio Com2 - Incoming speech on COM2
- xplm_
Audio Radio Copilot - Copilot’s own speech
- xplm_
Audio Radio Pilot - Pilot’s own speech
- xplm_
AudioUI - Copilot’s own speech
- xplm_
Command Begin - The command is being started.
- xplm_
Command Continue - The command is continuing to execute.
- xplm_
Command End - The command has ended.
- xplm_
Control Camera Forever - Control the camera until your plugin is disabled or another plugin forcibly* takes control.
- xplm_
Control Camera Until View Changes - Control the camera until the user picks a new view.
- xplm_
Control Flag - The control key is down
- xplm_
Cursor Arrow - X-Plane shows the cursor as the default arrow.
- xplm_
Cursor Custom - X-Plane shows the cursor but lets you select an OS cursor.
- xplm_
Cursor Default - X-Plane manages the cursor normally, plugin does not affect the cusrsor.
- xplm_
Cursor Hidden - X-Plane hides the cursor.
- xplm_
Data File_ Replay Movie - A situation movie (.smo) file, which replays a past flight.
- xplm_
Data File_ Situation - A situation (.sit) file, which starts off a flight in a given * configuration.
- xplm_
Down Flag - The key is being pressed down
- xplm_
Flight Loop_ Phase_ After Flight Model - Your callback runs after X-Plane integrates the flight model.
- xplm_
Flight Loop_ Phase_ Before Flight Model - Your callback runs before X-Plane integrates the flight model.
- xplm_
Host_ Unknown - xplm_
Host_ XPlane - xplm_
Language_ Chinese - xplm_
Language_ English - xplm_
Language_ French - xplm_
Language_ German - xplm_
Language_ Greek - xplm_
Language_ Italian - xplm_
Language_ Japanese - xplm_
Language_ Korean - xplm_
Language_ Russian - xplm_
Language_ Spanish - xplm_
Language_ Unknown - xplm_
MapLayer_ Fill - A layer that draws “fill” graphics, like weather patterns, terrain, etc. * Fill layers frequently cover a large portion of the visible map area.
- xplm_
MapLayer_ Markings - A layer that provides markings for particular map features, like NAVAIDs, * airports, etc. Even dense markings layers cover a small portion of the * total map area.
- xplm_
MapOrientation_ Map - Orient such that a 0 degree rotation matches the map’s north
- xplm_
MapOrientation_ UI - Orient such that a 0 degree rotation is “up” relative to the user interface
- xplm_
MapStyle_ IFR_ High Enroute - xplm_
MapStyle_ IFR_ LowEnroute - xplm_
MapStyle_ VFR_ Sectional - xplm_
Master - Master bus. Not normally to be used directly.
- xplm_
Master Bank - Master bank. Handles all aircraft and environmental audio.
- xplm_
Menu_ Checked - The menu has a mark next to it that is checked (lit).
- xplm_
Menu_ NoCheck - There is no symbol to the left of the menu item.
- xplm_
Menu_ Unchecked - The menu has a mark next to it that is unmarked (not lit).
- xplm_
Mouse Down - xplm_
Mouse Drag - xplm_
Mouse Up - xplm_
Nav_ Airport - xplm_
Nav_ DME - xplm_
Nav_ Fix - xplm_
Nav_ Glide Slope - xplm_
Nav_ ILS - xplm_
Nav_ Inner Marker - xplm_
Nav_ LatLon - xplm_
Nav_ Localizer - xplm_
Nav_ Middle Marker - xplm_
Nav_ NDB - xplm_
Nav_ Outer Marker - xplm_
Nav_ Unknown - xplm_
Nav_ VOR - xplm_
Option AltFlag - The option or alt key is down
- xplm_
Phase_ First Cockpit - This is the first phase where you can draw in 2-d.
- xplm_
Phase_ Gauges - The moving parts of the aircraft panel.
- xplm_
Phase_ Last Cockpit - The last chance to draw in 2d.
- xplm_
Phase_ Local Map2D - Removed as of XPLM300; Use the full-blown XPLMMap API instead.
- xplm_
Phase_ Local Map3D - Removed as of XPLM300; Use the full-blown XPLMMap API instead.
- xplm_
Phase_ Local MapProfile - Removed as of XPLM300; Use the full-blown XPLMMap API instead.
- xplm_
Phase_ Panel - The non-moving parts of the aircraft panel.
- xplm_
Phase_ Window - Floating windows from plugins.
- xplm_
Probe Error - An error in the API call. Either the probe struct size is bad, the probe * is invalid, or the type is mismatched for the specific query call.
- xplm_
Probe HitTerrain - The probe hit terrain and returned valid values.
- xplm_
Probe Missed - The probe call succeeded but there is no terrain under this point (perhaps * it is off the side of the planet?)
- xplm_
ProbeY - The Y probe gives you the location of the tallest physical scenery along * the Y axis going through the queried point.
- xplm_
Radio Bank - Radio bank. Handles COM1/COM2/GND/Pilot/Copilot.
- xplm_
Shift Flag - The shift key is down
- xplm_
Tex_ General Interface - The bitmap that contains window outlines, button outlines, fonts, etc.
- xplm_
UpFlag - The key is being released
- xplm_
Window Center OnMonitor - Keep the window centered on the monitor you specify
- xplm_
Window Decoration None - X-Plane will draw no decoration for your window, and apply no automatic * click handlers. The window will not stop click from passing through its * bounds. This is suitable for “windows” which request, say, the full screen * bounds, then only draw in a small portion of the available area.
- xplm_
Window Decoration Round Rectangle - The default decoration for “native” windows, like the map. Provides a solid* background, as well as click handlers for resizing and dragging the window.
- xplm_
Window Decoration Self Decorated - X-Plane will draw no decoration for your window, nor will it provide resize* handlers for your window edges, but it will stop clicks from passing * through your windows bounds.
- xplm_
Window Decoration Self Decorated Resizable - Like self-decorated, but with resizing; X-Plane will draw no decoration for* your window, but it will stop clicks from passing through your windows * bounds, and provide automatic mouse handlers for resizing.
- xplm_
Window Full Screen OnAll Monitors - Like gui_window_full_screen_on_monitor, but stretches over all monitors * and popout windows. This is an obscure one… unless you have a very good * reason to need it, you probably don’t!
- xplm_
Window Full Screen OnMonitor - Keep the window full screen on the monitor you specify
- xplm_
Window Layer Flight Overlay - The lowest layer, used for HUD-like displays while flying.
- xplm_
Window Layer Floating Windows - Windows that “float” over the sim, like the X-Plane 11 map does. If you are* not sure which layer to create your window in, choose floating.
- xplm_
Window Layer Growl Notifications - “Growl”-style notifications that are visible in a corner of the screen, * even over modals
- xplm_
Window Layer Modal - An interruptive modal that covers the sim with a transparent black overlay * to draw the user’s focus to the alert
- xplm_
Window PopOut - A first-class window in the operating system, completely separate from the * X-Plane window(s)
- xplm_
Window Position Free - The default positioning mode. Set the window geometry and its future * position will be determined by its window gravity, resizing limits, and * user interactions.
- xplm_
WindowVR - A floating window visible on the VR headset
- xplm_
device_ CDU739_ 1 - generic airliner CDU, pilot side.
- xplm_
device_ CDU739_ 2 - generic airliner CDU, copilot side.
- xplm_
device_ CDU815_ 1 - Primus CDU, pilot side.
- xplm_
device_ CDU815_ 2 - Primus CDU, copilot side.
- xplm_
device_ G1000_ MFD - G1000 Multifunction Display.
- xplm_
device_ G1000_ PFD_ 1 - G1000 Primary Flight Display, pilot side.
- xplm_
device_ G1000_ PFD_ 2 - G1000 Primary Flight Display, copilot side.
- xplm_
device_ GNS430_ 1 - GNS430, pilot side.
- xplm_
device_ GNS430_ 2 - GNS430, copilot side.
- xplm_
device_ GNS530_ 1 - GNS530, pilot side.
- xplm_
device_ GNS530_ 2 - GNS530, copilot side.
- xplm_
device_ Primus_ MFD_ 1 - Primus Multifunction Display, pilot side.
- xplm_
device_ Primus_ MFD_ 2 - Primus Multifunction Display, copilot side.
- xplm_
device_ Primus_ MFD_ 3 - Primus Multifunction Display, central.
- xplm_
device_ Primus_ PFD_ 1 - Primus Primary Flight Display, pilot side.
- xplm_
device_ Primus_ PFD_ 2 - Primus Primary Flight Display, copilot side.
- xplm_
device_ Primus_ RMU_ 1 - Primus Radio Management Unit, pilot side.
- xplm_
device_ Primus_ RMU_ 2 - Primus Radio Management Unit, copilot side.
Statics§
Functions§
- XPAdd
Widget ⚠Callback - XPAddWidgetCallback
- XPBring
Root ⚠Widget ToFront - XPBringRootWidgetToFront
- XPCount
Child ⚠Widgets - XPCountChildWidgets
- XPCreate
Custom ⚠Widget - XPCreateCustomWidget
- XPCreate
Widget ⚠ - XPCreateWidget
- XPDestroy
Widget ⚠ - XPDestroyWidget
- XPDraw
Element ⚠ - XPDrawElement
- XPDraw
Track ⚠ - XPDrawTrack
- XPDraw
Window ⚠ - XPDrawWindow
- XPFind
Root ⚠Widget - XPFindRootWidget
- XPGet
Element ⚠Default Dimensions - XPGetElementDefaultDimensions
- XPGet
NthChild ⚠Widget - XPGetNthChildWidget
- XPGet
Parent ⚠Widget - XPGetParentWidget
- XPGet
Track ⚠Default Dimensions - XPGetTrackDefaultDimensions
- XPGet
Track ⚠Metrics - XPGetTrackMetrics
- XPGet
Widget ⚠Class Func - XPGetWidgetClassFunc
- XPGet
Widget ⚠Descriptor - XPGetWidgetDescriptor
- XPGet
Widget ⚠Exposed Geometry - XPGetWidgetExposedGeometry
- XPGet
Widget ⚠ForLocation - XPGetWidgetForLocation
- XPGet
Widget ⚠Geometry - XPGetWidgetGeometry
- XPGet
Widget ⚠Property - XPGetWidgetProperty
- XPGet
Widget ⚠Underlying Window - XPGetWidgetUnderlyingWindow
- XPGet
Widget ⚠With Focus - XPGetWidgetWithFocus
- XPGet
Window ⚠Default Dimensions - XPGetWindowDefaultDimensions
- XPHide
Widget ⚠ - XPHideWidget
- XPIs
Widget ⚠InFront - XPIsWidgetInFront
- XPIs
Widget ⚠Visible - XPIsWidgetVisible
- XPLM
Acquire ⚠Planes - XPLMAcquirePlanes
- XPLM
Append ⚠Menu Item - XPLMAppendMenuItem
- XPLM
Append ⚠Menu Item With Command - XPLMAppendMenuItemWithCommand
- XPLM
Append ⚠Menu Separator - XPLMAppendMenuSeparator
- XPLM
Bind ⚠Texture2d - XPLMBindTexture2d
- XPLM
Bring ⚠Window ToFront - XPLMBringWindowToFront
- XPLM
CanWrite ⚠Data Ref - XPLMCanWriteDataRef
- XPLM
Check ⚠Menu Item - XPLMCheckMenuItem
- XPLM
Check ⚠Menu Item State - XPLMCheckMenuItemState
- XPLM
Clear ⚠AllMenu Items - XPLMClearAllMenuItems
- XPLM
ClearFMS ⚠Entry - XPLMClearFMSEntry
- XPLM
Command ⚠Begin - XPLMCommandBegin
- XPLM
Command ⚠End - XPLMCommandEnd
- XPLM
Command ⚠Once - XPLMCommandOnce
- XPLM
Control ⚠Camera - XPLMControlCamera
- XPLM
Count ⚠Aircraft - XPLMCountAircraft
- XPLM
Count ⚠Data Refs - XPLMCountDataRefs
- XPLM
CountFMS ⚠Entries - XPLMCountFMSEntries
- XPLM
Count ⚠HotKeys - XPLMCountHotKeys
- XPLM
Count ⚠Plugins - XPLMCountPlugins
- XPLM
Create ⚠Command - XPLMCreateCommand
- XPLM
Create ⚠Flight Loop - XPLMCreateFlightLoop
- XPLM
Create ⚠Instance - XPLMCreateInstance
- XPLM
Create ⚠MapLayer - XPLMCreateMapLayer
- XPLM
Create ⚠Menu - XPLMCreateMenu
- XPLM
Create ⚠Probe - XPLMCreateProbe
- XPLM
Create ⚠Window - XPLMCreateWindow
- XPLM
Create ⚠Window Ex - XPLMCreateWindowEx
- XPLM
Debug ⚠String - XPLMDebugString
- XPLM
DegMagnetic ⚠ToDeg True - XPLMDegMagneticToDegTrue
- XPLM
DegTrue ⚠ToDeg Magnetic - XPLMDegTrueToDegMagnetic
- XPLM
Destroy ⚠Flight Loop - XPLMDestroyFlightLoop
- XPLM
Destroy ⚠Instance - XPLMDestroyInstance
- XPLM
Destroy ⚠MapLayer - XPLMDestroyMapLayer
- XPLM
Destroy ⚠Menu - XPLMDestroyMenu
- XPLM
Destroy ⚠Probe - XPLMDestroyProbe
- XPLM
Destroy ⚠Window - XPLMDestroyWindow
- XPLM
DisableAI ⚠ForPlane - XPLMDisableAIForPlane
- XPLM
Disable ⚠Plugin - XPLMDisablePlugin
- XPLM
Dont ⚠Control Camera - XPLMDontControlCamera
- XPLM
Draw ⚠MapIcon From Sheet - XPLMDrawMapIconFromSheet
- XPLM
Draw ⚠MapLabel - XPLMDrawMapLabel
- XPLM
Draw ⚠Number - XPLMDrawNumber
- XPLM
Draw ⚠String - XPLMDrawString
- XPLM
Draw ⚠Translucent Dark Box - XPLMDrawTranslucentDarkBox
- XPLM
Enable ⚠Feature - XPLMEnableFeature
- XPLM
Enable ⚠Menu Item - XPLMEnableMenuItem
- XPLM
Enable ⚠Plugin - XPLMEnablePlugin
- XPLM
Enumerate ⚠Features - XPLMEnumerateFeatures
- XPLM
Extract ⚠File AndPath - XPLMExtractFileAndPath
- XPLM
Find ⚠Aircraft Menu - XPLMFindAircraftMenu
- XPLM
Find ⚠Command - XPLMFindCommand
- XPLM
Find ⚠Data Ref - XPLMFindDataRef
- XPLM
Find ⚠First NavAid OfType - XPLMFindFirstNavAidOfType
- XPLM
Find ⚠Last NavAid OfType - XPLMFindLastNavAidOfType
- XPLM
Find ⚠NavAid - XPLMFindNavAid
- XPLM
Find ⚠Plugin ByPath - XPLMFindPluginByPath
- XPLM
Find ⚠Plugin BySignature - XPLMFindPluginBySignature
- XPLM
Find ⚠Plugins Menu - XPLMFindPluginsMenu
- XPLM
Find ⚠Symbol - XPLMFindSymbol
- XPLM
Generate ⚠Texture Numbers - XPLMGenerateTextureNumbers
- XPLM
GetAll ⚠Monitor Bounds Global - XPLMGetAllMonitorBoundsGlobal
- XPLM
GetAll ⚠Monitor BoundsOS - XPLMGetAllMonitorBoundsOS
- XPLM
GetCycle ⚠Number - XPLMGetCycleNumber
- XPLM
GetData ⚠RefInfo - XPLMGetDataRefInfo
- XPLM
GetData ⚠RefTypes - XPLMGetDataRefTypes
- XPLM
GetData ⚠Refs ByIndex - XPLMGetDataRefsByIndex
- XPLM
GetDatab ⚠ - XPLMGetDatab
- XPLM
GetDatad ⚠ - XPLMGetDatad
- XPLM
GetDataf ⚠ - XPLMGetDataf
- XPLM
GetDatai ⚠ - XPLMGetDatai
- XPLM
GetDatavf ⚠ - XPLMGetDatavf
- XPLM
GetDatavi ⚠ - XPLMGetDatavi
- XPLM
GetDestinationFMS ⚠Entry - XPLMGetDestinationFMSEntry
- XPLM
GetDirectory ⚠Contents - XPLMGetDirectoryContents
- XPLM
GetDirectory ⚠Separator - XPLMGetDirectorySeparator
- XPLM
GetDisplayedFMS ⚠Entry - XPLMGetDisplayedFMSEntry
- XPLM
GetElapsed ⚠Time - XPLMGetElapsedTime
- XPLM
GetFMS ⚠Entry Info - XPLMGetFMSEntryInfo
- XPLM
GetFirst ⚠NavAid - XPLMGetFirstNavAid
- XPLM
GetFont ⚠Dimensions - XPLMGetFontDimensions
- XPLM
GetGPS ⚠Destination - XPLMGetGPSDestination
- XPLM
GetGPS ⚠Destination Type - XPLMGetGPSDestinationType
- XPLM
GetHot ⚠KeyInfo - XPLMGetHotKeyInfo
- XPLM
GetLanguage ⚠ - XPLMGetLanguage
- XPLM
GetMETAR ⚠ForAirport - XPLMGetMETARForAirport
- XPLM
GetMagnetic ⚠Variation - XPLMGetMagneticVariation
- XPLM
GetMouse ⚠Location - XPLMGetMouseLocation
- XPLM
GetMouse ⚠Location Global - XPLMGetMouseLocationGlobal
- XPLM
GetMyID ⚠ - XPLMGetMyID
- XPLM
GetNav ⚠AidInfo - XPLMGetNavAidInfo
- XPLM
GetNext ⚠NavAid - XPLMGetNextNavAid
- XPLM
GetNth ⚠Aircraft Model - XPLMGetNthAircraftModel
- XPLM
GetNth ⚠HotKey - XPLMGetNthHotKey
- XPLM
GetNth ⚠Plugin - XPLMGetNthPlugin
- XPLM
GetPlugin ⚠Info - XPLMGetPluginInfo
- XPLM
GetPrefs ⚠Path - XPLMGetPrefsPath
- XPLM
GetScreen ⚠Bounds Global - XPLMGetScreenBoundsGlobal
- XPLM
GetScreen ⚠Size - XPLMGetScreenSize
- XPLM
GetSystem ⚠Path - XPLMGetSystemPath
- XPLM
GetVersions ⚠ - XPLMGetVersions
- XPLM
GetVirtual ⚠KeyDescription - XPLMGetVirtualKeyDescription
- XPLM
GetWeather ⚠AtLocation - XPLMGetWeatherAtLocation
- XPLM
GetWindow ⚠Geometry - XPLMGetWindowGeometry
- XPLM
GetWindow ⚠GeometryOS - XPLMGetWindowGeometryOS
- XPLM
GetWindow ⚠GeometryVR - XPLMGetWindowGeometryVR
- XPLM
GetWindow ⚠IsVisible - XPLMGetWindowIsVisible
- XPLM
GetWindow ⚠RefCon - XPLMGetWindowRefCon
- XPLM
HasFeature ⚠ - XPLMHasFeature
- XPLM
HasKeyboard ⚠Focus - XPLMHasKeyboardFocus
- XPLM
Instance ⚠SetPosition - XPLMInstanceSetPosition
- XPLM
IsCamera ⚠Being Controlled - XPLMIsCameraBeingControlled
- XPLM
IsData ⚠RefGood - XPLMIsDataRefGood
- XPLM
IsFeature ⚠Enabled - XPLMIsFeatureEnabled
- XPLM
IsPlugin ⚠Enabled - XPLMIsPluginEnabled
- XPLM
IsWindow ⚠InFront - XPLMIsWindowInFront
- XPLM
Load ⚠Data File - XPLMLoadDataFile
- XPLM
Load ⚠Object - XPLMLoadObject
- XPLM
Load ⚠Object Async - XPLMLoadObjectAsync
- XPLM
Local ⚠ToWorld - XPLMLocalToWorld
- XPLM
Lookup ⚠Objects - XPLMLookupObjects
- XPLM
MapExists ⚠ - XPLMMapExists
- XPLM
MapGet ⚠North Heading - XPLMMapGetNorthHeading
- XPLM
MapProject ⚠ - XPLMMapProject
- XPLM
MapScale ⚠Meter - XPLMMapScaleMeter
- XPLM
MapUnproject ⚠ - XPLMMapUnproject
- XPLM
Measure ⚠String - XPLMMeasureString
- XPLM
Place ⚠User AtAirport - XPLMPlaceUserAtAirport
- XPLM
Place ⚠User AtLocation - XPLMPlaceUserAtLocation
- XPLM
PlayPCM ⚠OnBus - XPLMPlayPCMOnBus
- XPLM
Probe ⚠TerrainXYZ - XPLMProbeTerrainXYZ
- XPLM
Read ⚠Camera Position - XPLMReadCameraPosition
- XPLM
Register ⚠Avionics Callbacks Ex - XPLMRegisterAvionicsCallbacksEx
- XPLM
Register ⚠Command Handler - XPLMRegisterCommandHandler
- XPLM
Register ⚠Data Accessor - XPLMRegisterDataAccessor
- XPLM
Register ⚠Draw Callback - XPLMRegisterDrawCallback
- XPLM
Register ⚠Flight Loop Callback - XPLMRegisterFlightLoopCallback
- XPLM
Register ⚠HotKey - XPLMRegisterHotKey
- XPLM
Register ⚠KeySniffer - XPLMRegisterKeySniffer
- XPLM
Register ⚠MapCreation Hook - XPLMRegisterMapCreationHook
- XPLM
Release ⚠Planes - XPLMReleasePlanes
- XPLM
Reload ⚠Plugins - XPLMReloadPlugins
- XPLM
Reload ⚠Scenery - XPLMReloadScenery
- XPLM
Remove ⚠Menu Item - XPLMRemoveMenuItem
- XPLM
Save ⚠Data File - XPLMSaveDataFile
- XPLM
Schedule ⚠Flight Loop - XPLMScheduleFlightLoop
- XPLM
Send ⚠Message ToPlugin - XPLMSendMessageToPlugin
- XPLM
SetActive ⚠Aircraft Count - XPLMSetActiveAircraftCount
- XPLM
SetAircraft ⚠Model - XPLMSetAircraftModel
- XPLM
SetAudio ⚠Cone - XPLMSetAudioCone
- XPLM
SetAudio ⚠Fade Distance - XPLMSetAudioFadeDistance
- XPLM
SetAudio ⚠Pitch - XPLMSetAudioPitch
- XPLM
SetAudio ⚠Position - XPLMSetAudioPosition
- XPLM
SetAudio ⚠Volume - XPLMSetAudioVolume
- XPLM
SetDatab ⚠ - XPLMSetDatab
- XPLM
SetDatad ⚠ - XPLMSetDatad
- XPLM
SetDataf ⚠ - XPLMSetDataf
- XPLM
SetDatai ⚠ - XPLMSetDatai
- XPLM
SetDatavf ⚠ - XPLMSetDatavf
- XPLM
SetDatavi ⚠ - XPLMSetDatavi
- XPLM
SetDestinationFMS ⚠Entry - XPLMSetDestinationFMSEntry
- XPLM
SetDisplayedFMS ⚠Entry - XPLMSetDisplayedFMSEntry
- XPLM
SetError ⚠Callback - XPLMSetErrorCallback
- XPLM
SetFMS ⚠Entry Info - XPLMSetFMSEntryInfo
- XPLM
SetFMS ⚠Entry LatLon - XPLMSetFMSEntryLatLon
- XPLM
SetFlight ⚠Loop Callback Interval - XPLMSetFlightLoopCallbackInterval
- XPLM
SetGraphics ⚠State - XPLMSetGraphicsState
- XPLM
SetHot ⚠KeyCombination - XPLMSetHotKeyCombination
- XPLM
SetMenu ⚠Item Name - XPLMSetMenuItemName
- XPLM
SetUsers ⚠Aircraft - XPLMSetUsersAircraft
- XPLM
SetWindow ⚠Geometry - XPLMSetWindowGeometry
- XPLM
SetWindow ⚠GeometryOS - XPLMSetWindowGeometryOS
- XPLM
SetWindow ⚠GeometryVR - XPLMSetWindowGeometryVR
- XPLM
SetWindow ⚠Gravity - XPLMSetWindowGravity
- XPLM
SetWindow ⚠IsVisible - XPLMSetWindowIsVisible
- XPLM
SetWindow ⚠Positioning Mode - XPLMSetWindowPositioningMode
- XPLM
SetWindow ⚠RefCon - XPLMSetWindowRefCon
- XPLM
SetWindow ⚠Resizing Limits - XPLMSetWindowResizingLimits
- XPLM
SetWindow ⚠Title - XPLMSetWindowTitle
- XPLM
Share ⚠Data - XPLMShareData
- XPLM
Speak ⚠String - XPLMSpeakString
- XPLM
Stop ⚠Audio - XPLMStopAudio
- XPLM
Take ⚠Keyboard Focus - XPLMTakeKeyboardFocus
- XPLM
Unload ⚠Object - XPLMUnloadObject
- XPLM
Unregister ⚠Avionics Callbacks - XPLMUnregisterAvionicsCallbacks
- XPLM
Unregister ⚠Command Handler - XPLMUnregisterCommandHandler
- XPLM
Unregister ⚠Data Accessor - XPLMUnregisterDataAccessor
- XPLM
Unregister ⚠Draw Callback - XPLMUnregisterDrawCallback
- XPLM
Unregister ⚠Flight Loop Callback - XPLMUnregisterFlightLoopCallback
- XPLM
Unregister ⚠HotKey - XPLMUnregisterHotKey
- XPLM
Unregister ⚠KeySniffer - XPLMUnregisterKeySniffer
- XPLM
Unshare ⚠Data - XPLMUnshareData
- XPLM
Window ⚠IsInVR - XPLMWindowIsInVR
- XPLM
Window ⚠IsPopped Out - XPLMWindowIsPoppedOut
- XPLM
World ⚠ToLocal - XPLMWorldToLocal
- XPLose
Keyboard ⚠Focus - XPLoseKeyboardFocus
- XPPlace
Widget ⚠Within - XPPlaceWidgetWithin
- XPSend
Message ⚠ToWidget - XPSendMessageToWidget
- XPSet
Keyboard ⚠Focus - XPSetKeyboardFocus
- XPSet
Widget ⚠Descriptor - XPSetWidgetDescriptor
- XPSet
Widget ⚠Geometry - XPSetWidgetGeometry
- XPSet
Widget ⚠Property - XPSetWidgetProperty
- XPShow
Widget ⚠ - XPShowWidget
- XPUCreate
Widgets ⚠ - XPUCreateWidgets
- XPUDefocus
Keyboard ⚠ - XPUDefocusKeyboard
- XPUDrag
Widget ⚠ - XPUDragWidget
- XPUFixed
Layout ⚠ - XPUFixedLayout
- XPUMove
Widget ⚠By - XPUMoveWidgetBy
- XPUSelect
IfNeeded ⚠ - XPUSelectIfNeeded
- __
report_ ⚠gsfailure - __
security_ ⚠check_ cookie - __
security_ ⚠init_ cookie - __
va_ ⚠start
Type Aliases§
- FMOD_
CHANNEL - FMOD_
RESULT - These definitions are enough to play a basic sound without linking to the full FMOD distribution. You can still position it in 3D and change other basic parameters. In all cases where an FMOD_RESULT is returned, the full range of FMOD_RESULT codes are used - the status will in almost all situations be coming straight from FMOD - so the single definition here is purely to create a matching datatype and allow simple “is OK” and “is not OK” tests.
- FMOD_
SOUND_ FORMAT - XPDispatch
Mode - XPElement
Style - XPLM
Audio Bus - XPLM
Avionics Callback_ f - XPLMAvionicsCallback_f
- XPLM
AvionicsID - XPLMAvionicsID
- XPLM
BankID - XPLM
Camera Control Duration - XPLM
Camera Control_ f - XPLMCameraControl_f
- XPLM
Command Callback_ f - XPLMCommandCallback_f
- XPLM
Command Phase - XPLM
Command Ref - XPLMCommandRef
- XPLM
Cursor Status - XPLM
Data Changed_ f - XPLMDataChanged_f
- XPLM
Data File Type - XPLM
Data Ref - XPLMDataRef
- XPLM
Data TypeID - XPLM
DeviceID - XPLM
Draw Callback_ f - XPLMDrawCallback_f
- XPLM
Draw Window_ f - XPLMDrawWindow_f
- XPLM
Drawing Phase - XPLM
Error_ f - XPLMError_f
- XPLM
Feature Enumerator_ f - XPLMFeatureEnumerator_f
- XPLM
Flight LoopID - XPLMFlightLoopID
- XPLM
Flight Loop Phase Type - XPLM
Flight Loop_ f - XPLMFlightLoop_f
- XPLM
FontID - XPLM
GetDatab_ f - XPLMGetDatab_f
- XPLM
GetDatad_ f - XPLMGetDatad_f
- XPLM
GetDataf_ f - XPLMGetDataf_f
- XPLM
GetDatai_ f - XPLMGetDatai_f
- XPLM
GetDatavf_ f - XPLMGetDatavf_f
- XPLM
GetDatavi_ f - XPLMGetDatavi_f
- XPLM
Handle Cursor_ f - XPLMHandleCursor_f
- XPLM
Handle Key_ f - XPLMHandleKey_f
- XPLM
Handle Mouse Click_ f - XPLMHandleMouseClick_f
- XPLM
Handle Mouse Wheel_ f - XPLMHandleMouseWheel_f
- XPLM
Host ApplicationID - XPLM
HotKeyID - XPLMHotKeyID
- XPLM
HotKey_ f - XPLMHotKey_f
- XPLM
Instance Ref - XPLMInstanceRef
- XPLM
KeyFlags - XPLM
KeySniffer_ f - XPLMKeySniffer_f
- XPLM
Language Code - XPLM
Library Enumerator_ f - XPLMLibraryEnumerator_f
- XPLM
MapCreated Callback_ f - XPLMMapCreatedCallback_f
- XPLM
MapDrawing Callback_ f - XPLMMapDrawingCallback_f
- XPLM
MapIcon Drawing Callback_ f - XPLMMapIconDrawingCallback_f
- XPLM
MapLabel Drawing Callback_ f - XPLMMapLabelDrawingCallback_f
- XPLM
MapLayerID - XPLMMapLayerID
- XPLM
MapLayer Type - XPLM
MapOrientation - XPLM
MapPrepare Cache Callback_ f - XPLMMapPrepareCacheCallback_f
- XPLM
MapProjectionID - XPLMMapProjectionID
- XPLM
MapStyle - XPLM
MapWill BeDeleted Callback_ f - XPLMMapWillBeDeletedCallback_f
- XPLM
Menu Check - XPLM
Menu Handler_ f - XPLMMenuHandler_f
- XPLM
MenuID - XPLMMenuID
- XPLM
Mouse Status - XPLM
NavRef - XPLMNavRef
- XPLM
NavType - XPLM
Object Loaded_ f - XPLMObjectLoaded_f
- XPLM
Object Ref - XPLMObjectRef
- XPLMPCM
Complete_ f - XPLMPCMComplete_f
- XPLM
Planes Available_ f - XPLMPlanesAvailable_f
- XPLM
PluginID - XPLMPluginID
- XPLM
Probe Ref - XPLMProbeRef
- XPLM
Probe Result - XPLM
Probe Type - XPLM
Receive Monitor Bounds Global_ f - XPLMReceiveMonitorBoundsGlobal_f
- XPLM
Receive Monitor BoundsOS_ f - XPLMReceiveMonitorBoundsOS_f
- XPLM
SetDatab_ f - XPLMSetDatab_f
- XPLM
SetDatad_ f - XPLMSetDatad_f
- XPLM
SetDataf_ f - XPLMSetDataf_f
- XPLM
SetDatai_ f - XPLMSetDatai_f
- XPLM
SetDatavf_ f - XPLMSetDatavf_f
- XPLM
SetDatavi_ f - XPLMSetDatavi_f
- XPLM
TextureID - XPLM
Window Decoration - XPLM
WindowID - XPLMWindowID
- XPLM
Window Layer - XPLM
Window Positioning Mode - XPTrack
Style - XPWidget
Class - XPWidgetClass
- XPWidget
Func_ t - XPWidgetFunc_t
- XPWidgetID
- XPWidgetID
- XPWidget
Message - XPWidget
PropertyID - XPWindow
Style - __
vcrt_ bool - _bindgen_
ty_ 1 - XPLMKeyFlags
- _bindgen_
ty_ 2 - XPLMCameraControlDuration
- _bindgen_
ty_ 3 - XPLMDataTypeID
- _bindgen_
ty_ 4 - XPLMDrawingPhase
- _bindgen_
ty_ 5 - XPLMDeviceID
- _bindgen_
ty_ 6 - XPLMMouseStatus
- _bindgen_
ty_ 7 - XPLMCursorStatus
- _bindgen_
ty_ 8 - XPLMWindowLayer
- _bindgen_
ty_ 9 - XPLMWindowDecoration
- _bindgen_
ty_ 10 - XPLMWindowPositioningMode
- _bindgen_
ty_ 11 - XPLMTextureID
- _bindgen_
ty_ 12 - XPLMFontID
- _bindgen_
ty_ 13 - XPLMProbeType
- _bindgen_
ty_ 14 - XPLMProbeResult
- _bindgen_
ty_ 15 - XPLMMapStyle
- _bindgen_
ty_ 16 - XPLMMapLayerType
- _bindgen_
ty_ 17 - XPLMMapOrientation
- _bindgen_
ty_ 18 - XPLMDataFileType
- _bindgen_
ty_ 19 - XPLMHostApplicationID
- _bindgen_
ty_ 20 - XPLMLanguageCode
- _bindgen_
ty_ 21 - XPLMCommandPhase
- _bindgen_
ty_ 22 - XPLMMenuCheck
- _bindgen_
ty_ 23 - XPLMNavType
- _bindgen_
ty_ 24 - XPLMFlightLoopPhaseType
- _bindgen_
ty_ 25 - XPLMAudioBus
- _bindgen_
ty_ 26 - XPLMBankID
- _bindgen_
ty_ 27 - XPWidgetPropertyID
- _bindgen_
ty_ 28 - XPDispatchMode
- _bindgen_
ty_ 29 - XPWidgetMessage
- _bindgen_
ty_ 30 - Main Window Type Values
- _bindgen_
ty_ 31 - Main Window Properties
- _bindgen_
ty_ 32 - MainWindow Messages
- _bindgen_
ty_ 33 - SubWindow Type Values
- _bindgen_
ty_ 34 - SubWindow Properties
- _bindgen_
ty_ 35 - Button Types
- _bindgen_
ty_ 36 - Button Behavior Values
- _bindgen_
ty_ 37 - Button Properties
- _bindgen_
ty_ 38 - Button Messages
- _bindgen_
ty_ 39 - Text Field Type Values
- _bindgen_
ty_ 40 - Text Field Properties
- _bindgen_
ty_ 41 - Text Field Messages
- _bindgen_
ty_ 42 - Scroll Bar Type Values
- _bindgen_
ty_ 43 - Scroll Bar Properties
- _bindgen_
ty_ 44 - Scroll Bar Messages
- _bindgen_
ty_ 45 - Caption Properties
- _bindgen_
ty_ 46 - General Graphics Types Values
- _bindgen_
ty_ 47 - General Graphics Properties
- _bindgen_
ty_ 48 - Progress Indicator Properties
- _bindgen_
ty_ 49 - XPWindowStyle
- _bindgen_
ty_ 50 - XPElementStyle
- _bindgen_
ty_ 51 - XPTrackStyle
- int_
fast8_ t - int_
fast16_ t - int_
fast32_ t - int_
fast64_ t - int_
least8_ t - int_
least16_ t - int_
least32_ t - int_
least64_ t - intmax_
t - uint_
fast8_ t - uint_
fast16_ t - uint_
fast32_ t - uint_
fast64_ t - uint_
least8_ t - uint_
least16_ t - uint_
least32_ t - uint_
least64_ t - uintmax_
t - va_list
- wchar_t