Skip to content

Commit f0c41bb

Browse files
Added documentation
1 parent 29a89d4 commit f0c41bb

File tree

1,287 files changed

+123646
-15
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,287 files changed

+123646
-15
lines changed

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,6 @@ tmp
3030
local.properties
3131
project.properties
3232
proguard-project.txt
33-
html
3433
doc/latex
3534
*.obj
3635
Debug

Graphics/GraphicsEngineD3D11/src/RenderDeviceFactoryD3D11.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -331,7 +331,7 @@ void EngineFactoryD3D11Impl::CreateSwapChainD3D11( IRenderDevice *pDevice, Dilig
331331
/// \param [out] GetFactoryFunc - Pointer to the function that returns factory for D3D11 engine implementation
332332
/// See EngineFactoryD3D11Impl.
333333
/// \remarks Depending on the configuration and platform, the function loads different dll:
334-
/// Platform\\Configuration | Debug | Release
334+
/// Platform\\Configuration | Debug | Release
335335
/// --------------------------|-------------------------------|----------------------------
336336
/// x86 | GraphicsEngineD3D11_32d.dll | GraphicsEngineD3D11_32r.dll
337337
/// x64 | GraphicsEngineD3D11_64d.dll | GraphicsEngineD3D11_64r.dll

Graphics/GraphicsEngineD3D12/src/RenderDeviceFactoryD3D12.cpp

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -382,11 +382,10 @@ void EngineFactoryD3D12Impl::CreateSwapChainD3D12( IRenderDevice *pDevice,
382382

383383
#ifdef DOXYGEN
384384
/// Loads Direct3D12-based engine implementation and exports factory functions
385-
/// \param [out] GetFactoryFunc - Pointer to the function that returns factory for D3D12 engine implementation
386-
/// \param [out] CreateSwapChainFunc - Pointer to the function that creates swap chain.
387-
/// See EngineFactoryD3D12Impl.
385+
/// \param [out] GetFactoryFunc - Pointer to the function that returns factory for D3D12 engine implementation.
386+
/// See EngineFactoryD3D12Impl.
388387
/// \remarks Depending on the configuration and platform, the function loads different dll:
389-
/// Platform\\Configuration | Debug | Release
388+
/// Platform\\Configuration | Debug | Release
390389
/// --------------------------|-------------------------------|----------------------------
391390
/// x86 | GraphicsEngineD3D12_32d.dll | GraphicsEngineD3D12_32r.dll
392391
/// x64 | GraphicsEngineD3D12_64d.dll | GraphicsEngineD3D12_64r.dll

Graphics/GraphicsEngineOpenGL/interface/RenderDeviceGL.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ class IRenderDeviceGL : public IRenderDevice
5959
/// Creates a buffer from OpenGL handle
6060

6161
/// \param [in] GLHandle - OpenGL buffer handle
62-
/// \param [in] TexDesc - Buffer description. The engine can automatically
62+
/// \param [in] BuffDesc - Buffer description. The engine can automatically
6363
/// recover buffer size, but the rest of the fields need to
6464
/// be set by the client.
6565
/// \param [out] ppBuffer - Address of the memory location where the pointer to the

README.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ OpenGL and OpenGLES as well as basic platform-specific utilities.
1717

1818
| Project | Description |
1919
|------------------------------------------------------------------|-------------------|
20-
| [Primitives](Primitives) | Definitions of basic types (Int32, Int16, Uint32, etc.) and interfaces (IObject, IReferenceCounters, etc.) |
21-
| [Common](Common) | Common functionality such as file wrapper, logging, debug utilities, etc. |
20+
| [Primitives](/Primitives) | Definitions of basic types (Int32, Int16, Uint32, etc.) and interfaces (IObject, IReferenceCounters, etc.) |
21+
| [Common](/Common) | Common functionality such as file wrapper, logging, debug utilities, etc. |
2222
| [Graphics/GraphicsAccessories](Graphics/GraphicsAccessories) | Basic graphics accessories used by all implementations |
2323
| [Graphics/GraphicsEngine](Graphics/GraphicsEngine) | Platform-independent base functionality |
2424
| [Graphics/GraphicsEngineD3DBase](Graphics/GraphicsEngineD3DBase) | Base functionality for D3D11/D3D12 implementations |
@@ -127,9 +127,9 @@ imports the functions required to initialize the engine. You need to include the
127127
```
128128
You also need to add the following directories to the include search paths:
129129

130-
* diligentcore\Graphics\GraphicsEngineD3D11\interface
131-
* diligentcore\Graphics\GraphicsEngineD3D12\interface
132-
* diligentcore\Graphics\GraphicsEngineOpenGL\interface
130+
* diligentcore/Graphics/GraphicsEngineD3D11/interface
131+
* diligentcore/Graphics/GraphicsEngineD3D12/interface
132+
* diligentcore/Graphics/GraphicsEngineOpenGL/interface
133133

134134
Also, enable Diligent namespace:
135135

@@ -543,7 +543,7 @@ DispatchComputeAttribs DispatchAttrs(64, 64, 8);
543543
m_pContext->DispatchCompute(DispatchAttrs);
544544
```
545545
546-
You can learn more about the engine API by looking at the [engine samples' source code](http://diligentgraphics.com/diligent-engine/samples/) and the [API Reference](http://diligentgraphics.com/diligent-engine/api-reference/).
546+
You can learn more about the engine API by looking at the [engine samples' source code](https://github.com/DiligentGraphics/DiligentSamples) and the [API Reference](https://github.com/DiligentGraphics/DiligentEngine/doc/index.html).
547547
548548
549549
# Low-level API interoperability
@@ -623,6 +623,12 @@ Initial release
623623
624624
Licensed under the [Apache License, Version 2.0](License.txt)
625625
626-
**Copyright 2015-2017 Egor Yusov**
626+
# References
627+
628+
[Diligent Graphics on the Web](http://diligentgraphics.com)
629+
630+
[Diligent Graphics on Twitter](https://twitter.com/diligentengine)
631+
632+
[Diligent Graphics on Facebook](https://www.facebook.com/DiligentGraphics/)
627633
628-
[Diligent Graphics](http://diligentgraphics.com)
634+
**Copyright 2015-2018 Egor Yusov**

0 commit comments

Comments
 (0)