|
@@ -6,7 +6,7 @@ https://github.com/bkaradzic/bgfx
|
|
|
What is it?
|
|
What is it?
|
|
|
-----------
|
|
-----------
|
|
|
|
|
|
|
|
-Cross-platform rendering library ([API](https://github.com/bkaradzic/bgfx/blob/master/include/bgfx.h)).
|
|
|
|
|
|
|
+Cross-platform rendering library ([API documentation](https://github.com/bkaradzic/bgfx/blob/master/include/bgfx.h)).
|
|
|
|
|
|
|
|
Supported rendering backends:
|
|
Supported rendering backends:
|
|
|
|
|
|
|
@@ -38,6 +38,69 @@ scripting language, and an efficient command-line workflow. Here is video where
|
|
|
they explain why they choose bgfx over alternatives:
|
|
they explain why they choose bgfx over alternatives:
|
|
|
<a href="http://www.youtube.com/watch?feature=player_embedded&v=PHY_XHkMGIM&t=1m53s" target="_blank"><img src="http://img.youtube.com/vi/PHY_XHkMGIM/0.jpg" alt="Why did you choose bgfx?" width="240" height="180" border="10" /></a>
|
|
<a href="http://www.youtube.com/watch?feature=player_embedded&v=PHY_XHkMGIM&t=1m53s" target="_blank"><img src="http://img.youtube.com/vi/PHY_XHkMGIM/0.jpg" alt="Why did you choose bgfx?" width="240" height="180" border="10" /></a>
|
|
|
|
|
|
|
|
|
|
+Examples
|
|
|
|
|
+--------
|
|
|
|
|
+
|
|
|
|
|
+Most of the examples require shader/texture/mesh data to be loaded. When running
|
|
|
|
|
+examples your current directory should be examples/runtime.
|
|
|
|
|
+
|
|
|
|
|
+ <bgfx_path>/examples/runtime $ ../../.build/<config>/bin/example-00-helloworldDebug
|
|
|
|
|
+
|
|
|
|
|
+### 00-helloworld
|
|
|
|
|
+Initialization and debug text.
|
|
|
|
|
+
|
|
|
|
|
+### 01-cubes
|
|
|
|
|
+Rendering simple static mesh.
|
|
|
|
|
+
|
|
|
|
|
+
|
|
|
|
|
+
|
|
|
|
|
+### 02-metaballs
|
|
|
|
|
+Rendering with transient buffers and embedding shaders.
|
|
|
|
|
+
|
|
|
|
|
+
|
|
|
|
|
+
|
|
|
|
|
+### 03-raymarch
|
|
|
|
|
+Updating shader uniforms.
|
|
|
|
|
+
|
|
|
|
|
+
|
|
|
|
|
+
|
|
|
|
|
+### 04-mesh
|
|
|
|
|
+Loading meshes.
|
|
|
|
|
+
|
|
|
|
|
+
|
|
|
|
|
+
|
|
|
|
|
+### 05-instancing
|
|
|
|
|
+Geometry instancing.
|
|
|
|
|
+
|
|
|
|
|
+
|
|
|
|
|
+
|
|
|
|
|
+### 06-bump
|
|
|
|
|
+Loading textures.
|
|
|
|
|
+
|
|
|
|
|
+
|
|
|
|
|
+
|
|
|
|
|
+### 07-callback
|
|
|
|
|
+Implementing application specific callbacks for taking screen shots, caching
|
|
|
|
|
+OpenGL binary shaders, and video capture.
|
|
|
|
|
+
|
|
|
|
|
+### 08-update
|
|
|
|
|
+Updating textures.
|
|
|
|
|
+
|
|
|
|
|
+### 09-hdr
|
|
|
|
|
+Using multiple views and render targets.
|
|
|
|
|
+
|
|
|
|
|
+
|
|
|
|
|
+
|
|
|
|
|
+### 10-font
|
|
|
|
|
+Use the font system to display text and styled text.
|
|
|
|
|
+
|
|
|
|
|
+
|
|
|
|
|
+
|
|
|
|
|
+### 11-fontsdf
|
|
|
|
|
+Use a single distance field font to render text of various size.
|
|
|
|
|
+
|
|
|
|
|
+
|
|
|
|
|
+
|
|
|
Dependencies
|
|
Dependencies
|
|
|
------------
|
|
------------
|
|
|
|
|
|
|
@@ -131,69 +194,6 @@ Configuration is `<platform>-<debug/release>[32/64]`. For example:
|
|
|
linux-release32, nacl-debug64, nacl-arm-debug, pnacl-release,
|
|
linux-release32, nacl-debug64, nacl-arm-debug, pnacl-release,
|
|
|
android-release, etc.
|
|
android-release, etc.
|
|
|
|
|
|
|
|
-Examples
|
|
|
|
|
---------
|
|
|
|
|
-
|
|
|
|
|
-Most of the examples require shader/texture/mesh data to be loaded. When running
|
|
|
|
|
-examples your current directory should be examples/runtime.
|
|
|
|
|
-
|
|
|
|
|
- <bgfx_path>/examples/runtime $ ../../.build/<config>/bin/example-00-helloworldDebug
|
|
|
|
|
-
|
|
|
|
|
-### 00-helloworld
|
|
|
|
|
-Initialization and debug text.
|
|
|
|
|
-
|
|
|
|
|
-### 01-cubes
|
|
|
|
|
-Rendering simple static mesh.
|
|
|
|
|
-
|
|
|
|
|
-
|
|
|
|
|
-
|
|
|
|
|
-### 02-metaballs
|
|
|
|
|
-Rendering with transient buffers and embedding shaders.
|
|
|
|
|
-
|
|
|
|
|
-
|
|
|
|
|
-
|
|
|
|
|
-### 03-raymarch
|
|
|
|
|
-Updating shader uniforms.
|
|
|
|
|
-
|
|
|
|
|
-
|
|
|
|
|
-
|
|
|
|
|
-### 04-mesh
|
|
|
|
|
-Loading meshes.
|
|
|
|
|
-
|
|
|
|
|
-
|
|
|
|
|
-
|
|
|
|
|
-### 05-instancing
|
|
|
|
|
-Geometry instancing.
|
|
|
|
|
-
|
|
|
|
|
-
|
|
|
|
|
-
|
|
|
|
|
-### 06-bump
|
|
|
|
|
-Loading textures.
|
|
|
|
|
-
|
|
|
|
|
-
|
|
|
|
|
-
|
|
|
|
|
-### 07-callback
|
|
|
|
|
-Implementing application specific callbacks for taking screen shots, caching
|
|
|
|
|
-OpenGL binary shaders, and video capture.
|
|
|
|
|
-
|
|
|
|
|
-### 08-update
|
|
|
|
|
-Updating textures.
|
|
|
|
|
-
|
|
|
|
|
-### 09-hdr
|
|
|
|
|
-Using multiple views and render targets.
|
|
|
|
|
-
|
|
|
|
|
-
|
|
|
|
|
-
|
|
|
|
|
-### 10-font
|
|
|
|
|
-Use the font system to display text and styled text.
|
|
|
|
|
-
|
|
|
|
|
-
|
|
|
|
|
-
|
|
|
|
|
-### 11-fontsdf
|
|
|
|
|
-Use a single distance field font to render text of various size.
|
|
|
|
|
-
|
|
|
|
|
-
|
|
|
|
|
-
|
|
|
|
|
Internals
|
|
Internals
|
|
|
---------
|
|
---------
|
|
|
|
|
|