X-Git-Url: https://git.ucc.asn.au/?p=ipdf%2Fcode.git;a=blobdiff_plain;f=src%2Fframebuffer.h;h=920cbd2abb7efff2da7bbb27105eee37bbdcb12e;hp=1da3216ae09ad86dbca66928cf2f835b496c61e8;hb=888817a67a9d840be66b52811b01eb77f10ff3e6;hpb=a851cf197844a2eb15fd5ee2c350ee296e415dca

diff --git a/src/framebuffer.h b/src/framebuffer.h
index 1da3216..920cbd2 100644
--- a/src/framebuffer.h
+++ b/src/framebuffer.h
@@ -1,14 +1,15 @@
 #ifndef _FRAMEBUFFER_H
 #define _FRAMEBUFFER_H
 
-#include <SDL.h>
+#include "SDL.h"
 #include "gl_core44.h"
 
 
 namespace IPDF
 {
-	/*
+	/**
 	 * The "FrameBuffer" class represents an offscreen render target. 
+	 * FrameBuffer::Create needs to be called to initialise it; constructor is trivial
 	 */
 	class FrameBuffer
 	{
@@ -17,9 +18,9 @@ namespace IPDF
 		~FrameBuffer() { Destroy(); }
 		void Create(int w, int h);
 		void Destroy();
-		void Bind();
-		void UnBind();
-		void Blit();
+		void Bind(); // set as render target
+		void UnBind(); // set render target to screen
+		void Blit(); // blit this FrameBuffer to current render target
 		void Clear(float r=1.0, float g=1.0, float b=1.0, float a=1.0);
 		int GetWidth() { return m_width; }
 		int GetHeight() { return m_height; }