mirrors
/
bgfx
mirror of https://github.com/bkaradzic/bgfx
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated BGFX_PCI_ID docs to reflect GPU priority & added missing enums (#2888) 

* Add new BGFX_PCI_ID enums

* Updated BGFX_PCI_ID docs to reflect GPU priority & added missing enums

* Updated bgx.idl; minor corrections; ran GENie
This commit is contained in:
ichordev 2022-08-24 02:30:01 +10:00 committed by GitHub
parent 6cb74deed4
commit e9e9605304
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 31 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
bindings/d/types.d
View File

@ -897,19 +897,21 @@ struct bgfx_init_t
bgfx_renderer_type_t type; bgfx_renderer_type_t type;
/** /**
* Vendor PCI id. If set to `BGFX_PCI_ID_NONE` it will select the first * Vendor PCI ID. If set to `BGFX_PCI_ID_NONE`, discrete and integrated
* device. * GPUs will be prioritised.
* - `BGFX_PCI_ID_NONE` - Autoselect adapter. * - `BGFX_PCI_ID_NONE` - Autoselect adapter.
* - `BGFX_PCI_ID_SOFTWARE_RASTERIZER` - Software rasterizer. * - `BGFX_PCI_ID_SOFTWARE_RASTERIZER` - Software rasterizer.
* - `BGFX_PCI_ID_AMD` - AMD adapter. * - `BGFX_PCI_ID_AMD` - AMD adapter.
* - `BGFX_PCI_ID_APPLE` - Apple adapter.
* - `BGFX_PCI_ID_INTEL` - Intel adapter. * - `BGFX_PCI_ID_INTEL` - Intel adapter.
* - `BGFX_PCI_ID_NVIDIA` - nVidia adapter. * - `BGFX_PCI_ID_NVIDIA` - NVIDIA adapter.
* - `BGFX_PCI_ID_MICROSOFT` - Microsoft adapter.
*/ */
ushort vendorId; ushort vendorId;
/** /**
* Device id. If set to 0 it will select first device, or device with * Device ID. If set to 0 it will select first device, or device with
* matching id. * matching ID.
*/ */
ushort deviceId; ushort deviceId;
ulong capabilities; /// Capabilities initialization mask (default: UINT64_MAX). ulong capabilities; /// Capabilities initialization mask (default: UINT64_MAX).

2
docs/bgfx.rst
View File

@ -27,8 +27,10 @@ Initialization and Shutdown
.. doxygendefine:: BGFX_PCI_ID_NONE .. doxygendefine:: BGFX_PCI_ID_NONE
.. doxygendefine:: BGFX_PCI_ID_SOFTWARE_RASTERIZER .. doxygendefine:: BGFX_PCI_ID_SOFTWARE_RASTERIZER
.. doxygendefine:: BGFX_PCI_ID_AMD .. doxygendefine:: BGFX_PCI_ID_AMD
.. doxygendefine:: BGFX_PCI_ID_APPLE
.. doxygendefine:: BGFX_PCI_ID_INTEL .. doxygendefine:: BGFX_PCI_ID_INTEL
.. doxygendefine:: BGFX_PCI_ID_NVIDIA .. doxygendefine:: BGFX_PCI_ID_NVIDIA
.. doxygendefine:: BGFX_PCI_ID_MICROSOFT
.. doxygenstruct:: bgfx::CallbackI .. doxygenstruct:: bgfx::CallbackI
:members: :members:

14
include/bgfx/bgfx.h
View File

@ -651,17 +651,19 @@ namespace bgfx
/// See: `bgfx::RendererType` /// See: `bgfx::RendererType`
RendererType::Enum type; RendererType::Enum type;
/// Vendor PCI id. If set to `BGFX_PCI_ID_NONE` it will select the first /// Vendor PCI ID. If set to `BGFX_PCI_ID_NONE`, discrete and integrated
/// device. /// GPUs will be prioritised.
/// - `BGFX_PCI_ID_NONE` - Autoselect adapter. /// - `BGFX_PCI_ID_NONE` - Auto-select adapter.
/// - `BGFX_PCI_ID_SOFTWARE_RASTERIZER` - Software rasterizer. /// - `BGFX_PCI_ID_SOFTWARE_RASTERIZER` - Software rasterizer.
/// - `BGFX_PCI_ID_AMD` - AMD adapter. /// - `BGFX_PCI_ID_AMD` - AMD adapter.
/// - `BGFX_PCI_ID_APPLE` - Apple adapter.
/// - `BGFX_PCI_ID_INTEL` - Intel adapter. /// - `BGFX_PCI_ID_INTEL` - Intel adapter.
/// - `BGFX_PCI_ID_NVIDIA` - nVidia adapter. /// - `BGFX_PCI_ID_NVIDIA` - NVIDIA adapter.
/// - `BGFX_PCI_ID_MICROSOFT` - Microsoft adapter.
uint16_t vendorId; uint16_t vendorId;
/// Device id. If set to 0 it will select first device, or device with /// Device ID. If set to 0 it will select first device, or device with
/// matching id. /// matching ID.
uint16_t deviceId; uint16_t deviceId;
uint64_t capabilities; //!< Capabilities initialization mask (default: UINT64_MAX). uint64_t capabilities; //!< Capabilities initialization mask (default: UINT64_MAX).

12
include/bgfx/c99/bgfx.h
View File

@ -659,19 +659,21 @@ typedef struct bgfx_init_s
bgfx_renderer_type_t type; bgfx_renderer_type_t type;
/** /**
* Vendor PCI id. If set to `BGFX_PCI_ID_NONE` it will select the first * Vendor PCI ID. If set to `BGFX_PCI_ID_NONE`, discrete and integrated
* device. * GPUs will be prioritised.
* - `BGFX_PCI_ID_NONE` - Autoselect adapter. * - `BGFX_PCI_ID_NONE` - Autoselect adapter.
* - `BGFX_PCI_ID_SOFTWARE_RASTERIZER` - Software rasterizer. * - `BGFX_PCI_ID_SOFTWARE_RASTERIZER` - Software rasterizer.
* - `BGFX_PCI_ID_AMD` - AMD adapter. * - `BGFX_PCI_ID_AMD` - AMD adapter.
* - `BGFX_PCI_ID_APPLE` - Apple adapter.
* - `BGFX_PCI_ID_INTEL` - Intel adapter. * - `BGFX_PCI_ID_INTEL` - Intel adapter.
* - `BGFX_PCI_ID_NVIDIA` - nVidia adapter. * - `BGFX_PCI_ID_NVIDIA` - NVIDIA adapter.
* - `BGFX_PCI_ID_MICROSOFT` - Microsoft adapter.
*/ */
uint16_t vendorId; uint16_t vendorId;
/** /**
* Device id. If set to 0 it will select first device, or device with * Device ID. If set to 0 it will select first device, or device with
* matching id. * matching ID.
*/ */
uint16_t deviceId; uint16_t deviceId;
uint64_t capabilities; /** Capabilities initialization mask (default: UINT64_MAX). */ uint64_t capabilities; /** Capabilities initialization mask (default: UINT64_MAX). */

12
scripts/bgfx.idl
View File

@ -793,16 +793,18 @@ struct.Init { ctor }
--- a default rendering backend will be selected appropriate to the platform. --- a default rendering backend will be selected appropriate to the platform.
--- See: `bgfx::RendererType` --- See: `bgfx::RendererType`
.vendorId "uint16_t" --- Vendor PCI id. If set to `BGFX_PCI_ID_NONE` it will select the first .vendorId "uint16_t" --- Vendor PCI ID. If set to `BGFX_PCI_ID_NONE`, discrete and integrated
--- device. --- GPUs will be prioritised.
--- - `BGFX_PCI_ID_NONE` - Autoselect adapter. --- - `BGFX_PCI_ID_NONE` - Autoselect adapter.
--- - `BGFX_PCI_ID_SOFTWARE_RASTERIZER` - Software rasterizer. --- - `BGFX_PCI_ID_SOFTWARE_RASTERIZER` - Software rasterizer.
--- - `BGFX_PCI_ID_AMD` - AMD adapter. --- - `BGFX_PCI_ID_AMD` - AMD adapter.
--- - `BGFX_PCI_ID_APPLE` - Apple adapter.
--- - `BGFX_PCI_ID_INTEL` - Intel adapter. --- - `BGFX_PCI_ID_INTEL` - Intel adapter.
--- - `BGFX_PCI_ID_NVIDIA` - nVidia adapter. --- - `BGFX_PCI_ID_NVIDIA` - NVIDIA adapter.
--- - `BGFX_PCI_ID_MICROSOFT` - Microsoft adapter.
.deviceId "uint16_t" --- Device id. If set to 0 it will select first device, or device with .deviceId "uint16_t" --- Device ID. If set to 0 it will select first device, or device with
--- matching id. --- matching ID.
.capabilities "uint64_t" --- Capabilities initialization mask (default: UINT64_MAX). .capabilities "uint64_t" --- Capabilities initialization mask (default: UINT64_MAX).
.debug "bool" --- Enable device for debugging. .debug "bool" --- Enable device for debugging.
.profile "bool" --- Enable device for profiling. .profile "bool" --- Enable device for profiling.