Update and improve documentation

[libs/gl.git] / source / core / pipelinestate.h

diff --git a/source/core/pipelinestate.h b/source/core/pipelinestate.h
index 6d4d2f6441099a2565fc2d245e57f475bacd49f6..478705367a1b67a67b125f85f752a8f46d6014ee 100644 (file)
--- a/source/core/pipelinestate.h
+++ b/source/core/pipelinestate.h
@@ -20,6 +20,11 @@ class Texture;
 class UniformBlock;
 class VertexSetup;
 
+/**
+Stores state for the entire GPU pipeline.
+
+Applications normally use the higher-level Renderer class rather than this.
+*/
 class PipelineState: public PipelineStateBackend
 {
        friend PipelineStateBackend;