From ea4e8abcaae0f28a2fbd06b7b39c9a1d8bffefc0 Mon Sep 17 00:00:00 2001
From: David Rose <david@ddrose.com>
Date: Fri, 4 Sep 2009 16:43:30 +0000
Subject: [PATCH] new, better, make_buffer() interface

---
 panda/src/display/graphicsEngine.I | 41 +++++++++++++++++++++++++++++-
 panda/src/display/graphicsEngine.h |  3 +++
 2 files changed, 43 insertions(+), 1 deletion(-)

diff --git a/panda/src/display/graphicsEngine.I b/panda/src/display/graphicsEngine.I
index ea22df6c5e..3d11ab325d 100644
--- a/panda/src/display/graphicsEngine.I
+++ b/panda/src/display/graphicsEngine.I
@@ -114,7 +114,46 @@ close_gsg(GraphicsPipe *pipe, GraphicsStateGuardian *gsg) {
 ////////////////////////////////////////////////////////////////////
 //     Function: GraphicsEngine::make_buffer
 //       Access: Published
-//  Description: Syntactic shorthand for make_output
+//  Description: Syntactic shorthand for make_output.  This is the
+//               preferred way to create an offscreen buffer, when you
+//               already have an onscreen window or another buffer to
+//               start with.  For the first parameter, pass an
+//               existing GraphicsOutput object, e.g. the main window;
+//               this allows the buffer to adapt itself to that
+//               window's framebuffer properties, and allows maximum
+//               sharing of resources.
+////////////////////////////////////////////////////////////////////
+INLINE GraphicsOutput *GraphicsEngine::
+make_buffer(GraphicsOutput *host, const string &name,
+            int sort, int x_size, int y_size) {
+  GraphicsOutput *result = make_output(host->get_pipe(), name, sort,
+                                       FrameBufferProperties(), 
+                                       WindowProperties::size(x_size, y_size),
+                                       GraphicsPipe::BF_refuse_window |
+                                       GraphicsPipe::BF_fb_props_optional,
+                                       host->get_gsg(), host);
+  return result;
+}
+
+////////////////////////////////////////////////////////////////////
+//     Function: GraphicsEngine::make_buffer
+//       Access: Published
+//  Description: Syntactic shorthand for make_output.  This flavor
+//               accepts a GSG rather than a GraphicsOutput as the
+//               first parameter, which is too limiting and disallows
+//               the possibility of creating a ParasiteBuffer if the
+//               user's graphics hardware prefers that.  It also
+//               attempts to request specific framebuffer properties
+//               and may therefore do a poorer job of sharing the GSG
+//               between the old buffer and the new.
+//
+//               For these reasons, this variant is a poor choice
+//               unless you are creating an offscreen buffer for the
+//               first time, without an onscreen window already in
+//               existence.  If you already have an onscreen window,
+//               you should use the other flavor of make_buffer()
+//               instead, which accepts a GraphicsOutput as the first
+//               parameter.
 ////////////////////////////////////////////////////////////////////
 INLINE GraphicsOutput *GraphicsEngine::
 make_buffer(GraphicsStateGuardian *gsg, const string &name,
diff --git a/panda/src/display/graphicsEngine.h b/panda/src/display/graphicsEngine.h
index 8436c6afcd..386759a24f 100644
--- a/panda/src/display/graphicsEngine.h
+++ b/panda/src/display/graphicsEngine.h
@@ -79,6 +79,9 @@ PUBLISHED:
                               GraphicsOutput *host = NULL);
   
   // Syntactic shorthand versions of make_output
+  INLINE GraphicsOutput *make_buffer(GraphicsOutput *host,
+                                     const string &name, int sort,
+                                     int x_size, int y_size);
   INLINE GraphicsOutput *make_buffer(GraphicsStateGuardian *gsg,
                                      const string &name, int sort,
                                      int x_size, int y_size);