Skip to content

Commit 349de94

Browse files
TheMostDiligentTheMostDiligent
committed
Updated readme & documentation
1 parent f6ae6a2 commit 349de94

File tree

704 files changed

+1132
-1172
lines changed

Some content is hidden

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

704 files changed

+1132
-1172
lines changed

‎Common/readme.md‎

Lines changed: 0 additions & 24 deletions
This file was deleted.

‎Graphics/GraphicsEngineD3D11/readme.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ For more information about interoperability with D3D11, please visit [Diligent E
8484

8585
# References
8686

87-
[Diligent Engine](http://diligentgraphics.com/diligent-engine)
87+
[Diligent Engine on the Web](http://diligentgraphics.com/diligent-engine)
8888

8989
[Interoperability with Direct3D11](http://diligentgraphics.com/diligent-engine/native-api-interoperability/direct3d11-interoperability/)
9090

@@ -123,6 +123,6 @@ Initial release
123123

124124

125125

126-
**Copyright 2015-2017 Egor Yusov**
126+
**Copyright 2015-2018 Egor Yusov**
127127

128-
[Diligent Graphics](http://diligentgraphics.com)
128+
[diligentgraphics.com](http://diligentgraphics.com)

‎Graphics/GraphicsEngineD3D12/readme.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ For more information about interoperability with D3D12, please visit [Diligent E
101101

102102
# References
103103

104-
[Diligent Engine](http://diligentgraphics.com/diligent-engine)
104+
[Diligent Engine on the Web](http://diligentgraphics.com/diligent-engine)
105105

106106
[Interoperability with Direct3D12](http://diligentgraphics.com/diligent-engine/native-api-interoperability/direct3d12-interoperability/)
107107

@@ -151,6 +151,6 @@ Initial release
151151

152152

153153

154-
**Copyright 2015-2017 Egor Yusov**
154+
**Copyright 2015-2018 Egor Yusov**
155155

156-
[Diligent Graphics](http://diligentgraphics.com)
156+
[diligentgraphics.com](http://diligentgraphics.com)

‎Graphics/GraphicsEngineOpenGL/readme.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,6 @@ Initial release
107107

108108

109109

110-
**Copyright 2015-2017 Egor Yusov**
110+
**Copyright 2015-2018 Egor Yusov**
111111

112-
[Diligent Graphics](http://diligentgraphics.com)
112+
[diligentgraphics.com](http://diligentgraphics.com)

‎Graphics/HLSL2GLSLConverterLib/readme.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -294,6 +294,6 @@ Initial release
294294

295295

296296

297-
**Copyright 2015-2017 Egor Yusov**
297+
**Copyright 2015-2018 Egor Yusov**
298298

299-
[Diligent Graphics](http://diligentgraphics.com)
299+
[diligentgraphics.com](http://diligentgraphics.com)

‎README.md‎

Lines changed: 22 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -17,21 +17,21 @@ 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. |
22-
| [Graphics/GraphicsAccessories](Graphics/GraphicsAccessories) | Basic graphics accessories used by all implementations |
23-
| [Graphics/GraphicsEngine](Graphics/GraphicsEngine) | Platform-independent base functionality |
24-
| [Graphics/GraphicsEngineD3DBase](Graphics/GraphicsEngineD3DBase) | Base functionality for D3D11/D3D12 implementations |
25-
| [Graphics/GraphicsEngineD3D11](Graphics/GraphicsEngineD3D11) | Engine implementation with Direct3D11 |
26-
| [Graphics/GraphicsEngineD3D12](Graphics/GraphicsEngineD3D12) | Engine implementation with Direct3D12 |
27-
| [Graphics/GraphicsEngineOpenGL](Graphics/GraphicsEngineOpenGL) | Engine implementation with OpenGL/GLES |
28-
| [Graphics/GraphicsTools](Graphics/GraphicsTools) | Graphics utilities build on top of core interfaces (definitions of commonly used states, texture uploaders, etc.) |
29-
| [Graphics/HLSL2GLSLConverterLib](Graphics/HLSL2GLSLConverterLib) | HLSL to GLSL source code converter library |
30-
| [Platforms/Basic](Platforms/Basic) | Interface for platform-specific routines and implementation of some common functionality |
31-
| [Platforms/Android](Platforms/Android) | Implementation of platform-specific routines on Android |
32-
| [Platforms/UWP](Platforms/UWP) | Implementation of platform-specific routines on Universal Windows platform |
33-
| [Platforms/Win32](Platforms/Win32) | Implementation of platform-specific routines on Win32 platform |
34-
| [Platforms/Linux](Platforms/Linux) | Implementation of platform-specific routines on Linux platform |
20+
| [Primitives](https://github.com/DiligentGraphics/DiligentCore/tree/master/Primitives) | Definitions of basic types (Int32, Int16, Uint32, etc.) and interfaces (IObject, IReferenceCounters, etc.) |
21+
| [Common](https://github.com/DiligentGraphics/DiligentCore/tree/master/Common) | Common functionality such as file wrapper, logging, debug utilities, etc. |
22+
| [Graphics/GraphicsAccessories](https://github.com/DiligentGraphics/DiligentCore/tree/master/Graphics/GraphicsAccessories) | Basic graphics accessories used by all implementations |
23+
| [Graphics/GraphicsEngine](https://github.com/DiligentGraphics/DiligentCore/tree/master/Graphics/GraphicsEngine) | Platform-independent base functionality |
24+
| [Graphics/GraphicsEngineD3DBase](https://github.com/DiligentGraphics/DiligentCore/tree/master/Graphics/GraphicsEngineD3DBase)| Base functionality for D3D11/D3D12 implementations |
25+
| [Graphics/GraphicsEngineD3D11](https://github.com/DiligentGraphics/DiligentCore/tree/master/Graphics/GraphicsEngineD3D11) | Engine implementation with Direct3D11 |
26+
| [Graphics/GraphicsEngineD3D12](https://github.com/DiligentGraphics/DiligentCore/tree/master/Graphics/GraphicsEngineD3D12) | Engine implementation with Direct3D12 |
27+
| [Graphics/GraphicsEngineOpenGL](https://github.com/DiligentGraphics/DiligentCore/tree/master/Graphics/GraphicsEngineOpenGL) | Engine implementation with OpenGL/GLES |
28+
| [Graphics/GraphicsTools](https://github.com/DiligentGraphics/DiligentCore/tree/master/Graphics/GraphicsTools) | Graphics utilities build on top of core interfaces (definitions of commonly used states, texture uploaders, etc.) |
29+
| [Graphics/HLSL2GLSLConverterLib](https://github.com/DiligentGraphics/DiligentCore/tree/master/Graphics/HLSL2GLSLConverterLib) | HLSL to GLSL source code converter library |
30+
| [Platforms/Basic](https://github.com/DiligentGraphics/DiligentCore/tree/master/Platforms/Basic) | Interface for platform-specific routines and implementation of some common functionality |
31+
| [Platforms/Android](https://github.com/DiligentGraphics/DiligentCore/tree/master/Platforms/Android) | Implementation of platform-specific routines on Android |
32+
| [Platforms/UWP](https://github.com/DiligentGraphics/DiligentCore/tree/master/Platforms/UWP) | Implementation of platform-specific routines on Universal Windows platform |
33+
| [Platforms/Win32](https://github.com/DiligentGraphics/DiligentCore/tree/master/Platforms/Win32) | Implementation of platform-specific routines on Win32 platform |
34+
| [Platforms/Linux](https://github.com/DiligentGraphics/DiligentCore/tree/master/Platforms/Linux) | Implementation of platform-specific routines on Linux platform |
3535
| External/glew | Cross-platform library for loading OpenGL extensions |
3636

3737

@@ -142,7 +142,7 @@ also create a specified number of deferred contexts, which can be used for multi
142142
Deferred contexts can only be created during the initialization of the engine. The function populates an array of pointers
143143
to the contexts, where the immediate context goes at position 0, followed by all deferred contexts.
144144

145-
For more details, take a look at [WinMain.cpp](https://github.com/DiligentGraphics/DiligentSamples/blob/master/Samples/SampleBase/Src/Win32/WinMain.cpp) file.
145+
For more details, take a look at [WinMain.cpp](https://github.com/DiligentGraphics/DiligentSamples/blob/master/Samples/SampleBase/src/Win32/WinMain.cpp) file.
146146

147147
### Universal Windows Platform
148148

@@ -151,7 +151,7 @@ currently supported, but dynamic linking can also be implemented. Initialization
151151
way as on Win32 Platform. The difference is that you first create the render device and device contexts by
152152
calling `IEngineFactoryD3D11::CreateDeviceAndContextsD3D11()` or `IEngineFactoryD3D12::CreateDeviceAndContextsD3D12()`.
153153
The swap chain is created later by a call to `IEngineFactoryD3D11::CreateSwapChainD3D11()` or `IEngineFactoryD3D12::CreateSwapChainD3D12()`.
154-
Please look at the [DeviceResources.cpp](https://github.com/DiligentGraphics/DiligentSamples/blob/master/Samples/SampleBase/Src/UWP/Common/DeviceResources.cpp) file for more details.
154+
Please look at the [DeviceResources.cpp](https://github.com/DiligentGraphics/DiligentSamples/blob/master/Samples/SampleBase/src/UWP/Common/DeviceResources.cpp) file for more details.
155155

156156
### Linux
157157

@@ -566,9 +566,9 @@ objects. Refer to the following pages for more information:
566566
567567
[Diligent Engine on Facebook](https://www.facebook.com/DiligentGraphics/)
568568
569-
[Diligent Engine Architecture](http://diligentgraphics.com/diligent-engine/architecture/).
569+
[Diligent Engine Architecture](http://diligentgraphics.com/diligent-engine/architecture/)
570570
571-
[API Basics](http://diligentgraphics.com/diligent-engine/api-basics/).
571+
[API Basics](http://diligentgraphics.com/diligent-engine/api-basics/)
572572
573573
[API Reference][1]
574574
@@ -634,4 +634,6 @@ Licensed under the [Apache License, Version 2.0](License.txt)
634634
635635
**Copyright 2015-2018 Egor Yusov**
636636
637-
[1]: https://cdn.rawgit.com/DiligentGraphics/DiligentCore/f0c41bba/doc/html/index.html
637+
[diligentgraphics.com](http://diligentgraphics.com)
638+
639+
[1]: https://cdn.rawgit.com/DiligentGraphics/DiligentCore/f0c41bba/doc/html/index.html

‎doc/Doxyfile‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -795,7 +795,8 @@ INPUT = ..\Graphics\GraphicsEngineD3D11 \
795795
..\Common \
796796
..\Graphics\GraphicsEngineD3D12 \
797797
..\Graphics\GraphicsEngine \
798-
..\README.md
798+
..\README.md \
799+
..\Graphics\HLSL2GLSLConverterLib
799800

800801
# This tag can be used to specify the character encoding of the source files
801802
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

‎doc/html/_adaptive_fixed_block_allocator_8h_source.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@
7575
<!-- start footer part -->
7676
<!--
7777
<hr class="footer"/><address class="footer"><small>
78-
Generated on Wed Jan 3 2018 20:17:23 for Diligent Engine API Reference by &#160;<a href="http://www.doxygen.org/index.html">
78+
Generated on Wed Jan 3 2018 21:39:00 for Diligent Engine API Reference by &#160;<a href="http://www.doxygen.org/index.html">
7979
<img class="footer" src="doxygen.png" alt="doxygen"/>
8080
</a> 1.8.14
8181
</small></address>

‎doc/html/_advanced_math_8h_source.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@
7575
<!-- start footer part -->
7676
<!--
7777
<hr class="footer"/><address class="footer"><small>
78-
Generated on Wed Jan 3 2018 20:17:23 for Diligent Engine API Reference by &#160;<a href="http://www.doxygen.org/index.html">
78+
Generated on Wed Jan 3 2018 21:39:00 for Diligent Engine API Reference by &#160;<a href="http://www.doxygen.org/index.html">
7979
<img class="footer" src="doxygen.png" alt="doxygen"/>
8080
</a> 1.8.14
8181
</small></address>

‎doc/html/_async_writable_resource_8h_source.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@
7575
<!-- start footer part -->
7676
<!--
7777
<hr class="footer"/><address class="footer"><small>
78-
Generated on Wed Jan 3 2018 20:17:25 for Diligent Engine API Reference by &#160;<a href="http://www.doxygen.org/index.html">
78+
Generated on Wed Jan 3 2018 21:39:02 for Diligent Engine API Reference by &#160;<a href="http://www.doxygen.org/index.html">
7979
<img class="footer" src="doxygen.png" alt="doxygen"/>
8080
</a> 1.8.14
8181
</small></address>

0 commit comments

Comments
 (0)