Update and improve documentation

[libs/gl.git] / source / resources / resources.h

diff --git a/source/resources/resources.h b/source/resources/resources.h
index f1aec26b283b2d6cb871f551e84456ffcc8e6b1e..589ea5ae78d9f758b30fd2d65b55964983c09f1a 100644 (file)
--- a/source/resources/resources.h
+++ b/source/resources/resources.h
@@ -16,8 +16,44 @@ class Scene;
 class Texture2D;
 
 /**
-A collection class for GL resources.  Most useful as a base class for an
-application-specific collection.
+A collection class for GL resources.
+
+The following types of objects can be loaded:
+Animation                          .anim
+Armature                           .arma
+BasicMaterial (Material)           .mat
+Camera                             .camera
+DirectionalLight (Light)           .light
+Font                               .font
+KeyFrame                           .kframe
+Lighting                           .lightn
+Mesh                               .mesh
+Module                             .glsl .spv
+Object (Renderable)                .object
+OccludedScene (Scene, Renderable)  .scene
+OrderedScene (Scene, Renderable)   .scene
+PbrMaterial (Material)             .mat
+PointLight (Light)                 .light
+SequenceTemplate                   .seq
+Pose                               .pose
+Program                            .shader
+Sampler                            .samp
+SimpleScene (Scene, Renderable)    .scene
+Technique                          .tech
+Texture1D (Texture)                .tex
+Texture2D (Texture)                .tex .png .jpg
+Texture3D (Texture)                .tex
+TextureCube (Texture)              .tex
+Texture2DArray (Texture)           .tex
+UnlitMaterial (Material)           .mat
+ZSortedScene (Scene, Renderable)   .scene
+
+This class is normally used by deriving from it and adding any necessary data
+sources in the derived class.
+
+A ResourceManager can be set to manage objects derived from Resource.  Bulk
+data for those objects will then be loaded in the background, without blocking
+the main thread.
 */
 class Resources: virtual public DataFile::Collection
 {