Difference between revisions of "Engine:FNA"
(FNA3D changes) |
(Update launch options) |
||
| (6 intermediate revisions by 3 users not shown) | |||
| Line 9: | Line 9: | ||
'''FNA''' is an open source reimplementation of the Microsoft XNA Framework, specifically the 4.0 Refresh revision. It started as a branch of MonoGame called "MonoGame-SDL2". | '''FNA''' is an open source reimplementation of the Microsoft XNA Framework, specifically the 4.0 Refresh revision. It started as a branch of MonoGame called "MonoGame-SDL2". | ||
| − | The goal of the project is to recreate a fast, portable, and accurate XNA4 runtime library that prevents the need for code/content changes on the part of the XNA game developer. The currently supported platforms include Windows, | + | The goal of the project is to recreate a fast, portable, and accurate XNA4 runtime library that prevents the need for code/content changes on the part of the XNA game developer. The currently supported platforms include Windows, GNU/Linux, and macOS, with further platform support including those supported by SDL2. |
==Launch Options== | ==Launch Options== | ||
| Line 18: | Line 18: | ||
! Parameter !! Description | ! Parameter !! Description | ||
|- | |- | ||
| − | |/enablehighdpi:1 | + | |{{code|/enablehighdpi:1}} |
|On macOS and Wayland, attempt to use a Retina-capable window | |On macOS and Wayland, attempt to use a Retina-capable window | ||
|- | |- | ||
| − | |/mojoshaderprofile:... | + | |{{code|/mojoshaderprofile:...}} |
|Force a specific shader profile. Available options: glsl120, glspirv | |Force a specific shader profile. Available options: glsl120, glspirv | ||
|- | |- | ||
| − | |/backbufferscalenearest:1 | + | |{{code|/backbufferscalenearest:1}} |
|When scaling the game resolution, use a nearest-neighbor filter. Useful for pixel art games. | |When scaling the game resolution, use a nearest-neighbor filter. Useful for pixel art games. | ||
|- | |- | ||
| − | |/usescancodes:1 | + | |{{code|/usescancodes:1}} |
|Use scancodes for keyboard input, ignoring the user's keyboard layout | |Use scancodes for keyboard input, ignoring the user's keyboard layout | ||
|- | |- | ||
| − | |/disablelateswaptear:1 | + | |{{code|/disablelateswaptear:1}} |
|Do not use FIFO_RELAXED or EXT_swap_control_tear extension, disables adaptive VSync | |Do not use FIFO_RELAXED or EXT_swap_control_tear extension, disables adaptive VSync | ||
|- | |- | ||
| − | |/glprofile:... | + | |{{code|/forcemailboxvsync:1}} |
| + | |Enables triple-buffer vsync with the Vulkan renderer | ||
| + | |- | ||
| + | |{{code|/glprofile:...}} | ||
|Force a specific OpenGL profile. Available options: es3, core, compatibility | |Force a specific OpenGL profile. Available options: es3, core, compatibility | ||
|- | |- | ||
| − | |/gldevice:... | + | |{{code|/gldevice:...}} |
| − | |Force a specific renderer. Available options: OpenGL, Vulkan, D3D11 | + | |Force a specific renderer. Available options: OpenGL, Vulkan, D3D11 |
| − | |||
| − | |||
| − | |||
|} | |} | ||
| Line 51: | Line 51: | ||
===Automatic Configuration: SDL_GameController=== | ===Automatic Configuration: SDL_GameController=== | ||
| − | Since FNA uses SDL2 as its base library, we also get the benefit of SDL_GameController, a new subsystem added by Alfred Reynolds at Valve. This takes configurations for known controllers and automatically configures them for the virtual 360 controller, so if your controller is recognized, manual configuration is not necessary. If you run an FNA title through Steam, your controller will automatically be configured using the Big Picture Mode configuration. Additionally, FNA reads from a | + | Since FNA uses SDL2 as its base library, we also get the benefit of SDL_GameController, a new subsystem added by Alfred Reynolds at Valve. This takes configurations for known controllers and automatically configures them for the virtual 360 controller, so if your controller is recognized, manual configuration is not necessary. If you run an FNA title through Steam, your controller will automatically be configured using the Big Picture Mode configuration. Additionally, FNA reads from a {{code|gamecontrollerdb.txt}} file for configurations, when it's found in the game's base directory. You can find a community-sourced database [https://github.com/gabomdq/SDL_GameControllerDB/ here]. |
===About GUIDs=== | ===About GUIDs=== | ||
| Line 68: | Line 68: | ||
For XInput controllers on Windows, the GUID string is simply 'xinput'. | For XInput controllers on Windows, the GUID string is simply 'xinput'. | ||
| − | === | + | ===Sony Light Bar Support=== |
| − | {{ii}} | + | {{ii}} Previously only supported on Linux, FNA 21.01 introduced LED support for all operating systems. |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | FNA supports the DualShock 4 and DualSense light bar, although it requires game developers to make use of the [https://github.com/FNA-XNA/FNA/wiki/5:-FNA-Extensions#setlightbarext SetLightBarEXT] extension to set the color of the light bar by way of adjusting the brightness of the RGB LEDs. | |
| − | |||
| − | |||
| − | {{Infobox engine/ | + | {{Infobox engine/query}} |
{{References}} | {{References}} | ||
Revision as of 19:23, 27 October 2021
 |
|
| Developers | |
|---|---|
| Ethan Lee | |
| Website | |
| https://fna-xna.github.io | |
| First release date | |
| December 21, 2015 | |
| Predecessor | |
| XNA |
FNA is an open source reimplementation of the Microsoft XNA Framework, specifically the 4.0 Refresh revision. It started as a branch of MonoGame called "MonoGame-SDL2".
The goal of the project is to recreate a fast, portable, and accurate XNA4 runtime library that prevents the need for code/content changes on the part of the XNA game developer. The currently supported platforms include Windows, GNU/Linux, and macOS, with further platform support including those supported by SDL2.
Launch Options
As of FNA 20.01, a handful of command line arguments are supported automatically by games using FNA:
| Parameter | Description |
|---|---|
/enablehighdpi:1
|
On macOS and Wayland, attempt to use a Retina-capable window |
/mojoshaderprofile:...
|
Force a specific shader profile. Available options: glsl120, glspirv |
/backbufferscalenearest:1
|
When scaling the game resolution, use a nearest-neighbor filter. Useful for pixel art games. |
/usescancodes:1
|
Use scancodes for keyboard input, ignoring the user's keyboard layout |
/disablelateswaptear:1
|
Do not use FIFO_RELAXED or EXT_swap_control_tear extension, disables adaptive VSync |
/forcemailboxvsync:1
|
Enables triple-buffer vsync with the Vulkan renderer |
/glprofile:...
|
Force a specific OpenGL profile. Available options: es3, core, compatibility |
/gldevice:...
|
Force a specific renderer. Available options: OpenGL, Vulkan, D3D11 |
More detailed information about these options can be found on the FNA Developer Wiki.
Joysticks
About XNA Joystick Support
XNA, being a Microsoft technology, centered its controller input around the Xbox 360 Controller. Because of this, the XNA API is not cleanly compatible with custom controllers, including the Xbox 360 Controller when not being read by XInput. However, a config format was developed to allow binding of joystick input values to a virtual 360 controller, which then gets read by XNA games.
Automatic Configuration: SDL_GameController
Since FNA uses SDL2 as its base library, we also get the benefit of SDL_GameController, a new subsystem added by Alfred Reynolds at Valve. This takes configurations for known controllers and automatically configures them for the virtual 360 controller, so if your controller is recognized, manual configuration is not necessary. If you run an FNA title through Steam, your controller will automatically be configured using the Big Picture Mode configuration. Additionally, FNA reads from a gamecontrollerdb.txt file for configurations, when it's found in the game's base directory. You can find a community-sourced database here.
About GUIDs
In addition to expanded configuration support, FNA provides the GetGUIDEXT extension that allows XNA devs to pull in a trimmed/standardized GUID string to determine the controller hardware and react accordingly. TowerFall Ascension uses this for button icon support, for example.
Consider this GUID from the PlayStation 4 controller:
// This is the string reported by SDL2's SDL_JoystickGetGUIDString: // https://wiki.libsdl.org/SDL_JoystickGetGUIDString // Note characters 9-12 and 17-20. 030000004c050000c405000011010000
// This is the GUID string returned by FNA. Get it? 4c05c405
For XInput controllers on Windows, the GUID string is simply 'xinput'.
Sony Light Bar Support
- Previously only supported on Linux, FNA 21.01 introduced LED support for all operating systems.
FNA supports the DualShock 4 and DualSense light bar, although it requires game developers to make use of the SetLightBarEXT extension to set the color of the light bar by way of adjusting the brightness of the RGB LEDs.