renderbuffer.c revision fc41473b9f7d1171a2921a825807889b8fcbcaaf 
1/*
2 * Mesa 3-D graphics library
3 * Version:  6.5
4 *
5 * Copyright (C) 1999-2006  Brian Paul   All Rights Reserved.
6 *
7 * Permission is hereby granted, free of charge, to any person obtaining a
8 * copy of this software and associated documentation files (the "Software"),
9 * to deal in the Software without restriction, including without limitation
10 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
11 * and/or sell copies of the Software, and to permit persons to whom the
12 * Software is furnished to do so, subject to the following conditions:
13 *
14 * The above copyright notice and this permission notice shall be included
15 * in all copies or substantial portions of the Software.
16 *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
20 * BRIAN PAUL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
21 * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
22 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23 */
24
25
26#include "glheader.h"
27#include "imports.h"
28#include "context.h"
29#include "fbobject.h"
30#include "formats.h"
31#include "mtypes.h"
32#include "renderbuffer.h"
33
34
35/**
36 * Default GetPointer routine.  Always return NULL to indicate that
37 * direct buffer access is not supported.
38 */
39static void *
40nop_get_pointer(struct gl_context *ctx, struct gl_renderbuffer *rb, GLint x, GLint y)
41{
42   return NULL;
43}
44
45
46/**
47 * Initialize the fields of a gl_renderbuffer to default values.
48 */
49void
50_mesa_init_renderbuffer(struct gl_renderbuffer *rb, GLuint name)
51{
52   _glthread_INIT_MUTEX(rb->Mutex);
53
54   rb->ClassID = 0;
55   rb->Name = name;
56   rb->RefCount = 0;
57   rb->Delete = _mesa_delete_renderbuffer;
58
59   /* The rest of these should be set later by the caller of this function or
60    * the AllocStorage method:
61    */
62   rb->AllocStorage = NULL;
63
64   rb->Width = 0;
65   rb->Height = 0;
66   rb->InternalFormat = GL_RGBA;
67   rb->Format = MESA_FORMAT_NONE;
68
69   rb->DataType = GL_NONE;
70   rb->Data = NULL;
71
72   /* Point back to ourself so that we don't have to check for Wrapped==NULL
73    * all over the drivers.
74    */
75   rb->Wrapped = rb;
76
77   rb->GetPointer = nop_get_pointer;
78   rb->GetRow = NULL;
79   rb->GetValues = NULL;
80   rb->PutRow = NULL;
81   rb->PutRowRGB = NULL;
82   rb->PutValues = NULL;
83}
84
85
86/**
87 * Allocate a new gl_renderbuffer object.  This can be used for user-created
88 * renderbuffers or window-system renderbuffers.
89 */
90struct gl_renderbuffer *
91_mesa_new_renderbuffer(struct gl_context *ctx, GLuint name)
92{
93   struct gl_renderbuffer *rb = CALLOC_STRUCT(gl_renderbuffer);
94   if (rb) {
95      _mesa_init_renderbuffer(rb, name);
96   }
97   return rb;
98}
99
100
101/**
102 * Delete a gl_framebuffer.
103 * This is the default function for renderbuffer->Delete().
104 */
105void
106_mesa_delete_renderbuffer(struct gl_renderbuffer *rb)
107{
108   if (rb->Data) {
109      free(rb->Data);
110   }
111   free(rb);
112}
113
114
115/**
116 * Attach a renderbuffer to a framebuffer.
117 * \param bufferName  one of the BUFFER_x tokens
118 */
119void
120_mesa_add_renderbuffer(struct gl_framebuffer *fb,
121                       gl_buffer_index bufferName, struct gl_renderbuffer *rb)
122{
123   assert(fb);
124   assert(rb);
125   assert(bufferName < BUFFER_COUNT);
126
127   /* There should be no previous renderbuffer on this attachment point,
128    * with the exception of depth/stencil since the same renderbuffer may
129    * be used for both.
130    */
131   assert(bufferName == BUFFER_DEPTH ||
132          bufferName == BUFFER_STENCIL ||
133          fb->Attachment[bufferName].Renderbuffer == NULL);
134
135   /* winsys vs. user-created buffer cross check */
136   if (fb->Name) {
137      assert(rb->Name);
138   }
139   else {
140      assert(!rb->Name);
141   }
142
143   fb->Attachment[bufferName].Type = GL_RENDERBUFFER_EXT;
144   fb->Attachment[bufferName].Complete = GL_TRUE;
145   _mesa_reference_renderbuffer(&fb->Attachment[bufferName].Renderbuffer, rb);
146}
147
148
149/**
150 * Remove the named renderbuffer from the given framebuffer.
151 * \param bufferName  one of the BUFFER_x tokens
152 */
153void
154_mesa_remove_renderbuffer(struct gl_framebuffer *fb,
155                          gl_buffer_index bufferName)
156{
157   assert(bufferName < BUFFER_COUNT);
158   _mesa_reference_renderbuffer(&fb->Attachment[bufferName].Renderbuffer,
159                                NULL);
160}
161
162
163/**
164 * Set *ptr to point to rb.  If *ptr points to another renderbuffer,
165 * dereference that buffer first.  The new renderbuffer's refcount will
166 * be incremented.  The old renderbuffer's refcount will be decremented.
167 * This is normally only called from the _mesa_reference_renderbuffer() macro
168 * when there's a real pointer change.
169 */
170void
171_mesa_reference_renderbuffer_(struct gl_renderbuffer **ptr,
172                              struct gl_renderbuffer *rb)
173{
174   if (*ptr) {
175      /* Unreference the old renderbuffer */
176      GLboolean deleteFlag = GL_FALSE;
177      struct gl_renderbuffer *oldRb = *ptr;
178
179      _glthread_LOCK_MUTEX(oldRb->Mutex);
180      ASSERT(oldRb->RefCount > 0);
181      oldRb->RefCount--;
182      /*printf("RB DECR %p (%d) to %d\n", (void*) oldRb, oldRb->Name, oldRb->RefCount);*/
183      deleteFlag = (oldRb->RefCount == 0);
184      _glthread_UNLOCK_MUTEX(oldRb->Mutex);
185
186      if (deleteFlag) {
187         oldRb->Delete(oldRb);
188      }
189
190      *ptr = NULL;
191   }
192   assert(!*ptr);
193
194   if (rb) {
195      /* reference new renderbuffer */
196      _glthread_LOCK_MUTEX(rb->Mutex);
197      rb->RefCount++;
198      /*printf("RB INCR %p (%d) to %d\n", (void*) rb, rb->Name, rb->RefCount);*/
199      _glthread_UNLOCK_MUTEX(rb->Mutex);
200      *ptr = rb;
201   }
202}
203