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 * Initialize the fields of a gl_renderbuffer to default values.
37 */
38void
39_mesa_init_renderbuffer(struct gl_renderbuffer *rb, GLuint name)
40{
41   _glthread_INIT_MUTEX(rb->Mutex);
42
43   rb->ClassID = 0;
44   rb->Name = name;
45   rb->RefCount = 0;
46   rb->Delete = _mesa_delete_renderbuffer;
47
48   /* The rest of these should be set later by the caller of this function or
49    * the AllocStorage method:
50    */
51   rb->AllocStorage = NULL;
52
53   rb->Width = 0;
54   rb->Height = 0;
55   rb->InternalFormat = GL_RGBA;
56   rb->Format = MESA_FORMAT_NONE;
57}
58
59
60/**
61 * Allocate a new gl_renderbuffer object.  This can be used for user-created
62 * renderbuffers or window-system renderbuffers.
63 */
64struct gl_renderbuffer *
65_mesa_new_renderbuffer(struct gl_context *ctx, GLuint name)
66{
67   struct gl_renderbuffer *rb = CALLOC_STRUCT(gl_renderbuffer);
68   if (rb) {
69      _mesa_init_renderbuffer(rb, name);
70   }
71   return rb;
72}
73
74
75/**
76 * Delete a gl_framebuffer.
77 * This is the default function for renderbuffer->Delete().
78 * Drivers which subclass gl_renderbuffer should probably implement their
79 * own delete function.  But the driver might also call this function to
80 * free the object in the end.
81 */
82void
83_mesa_delete_renderbuffer(struct gl_context *ctx, struct gl_renderbuffer *rb)
84{
85   _glthread_DESTROY_MUTEX(rb->Mutex);
86   free(rb);
87}
88
89
90/**
91 * Attach a renderbuffer to a framebuffer.
92 * \param bufferName  one of the BUFFER_x tokens
93 */
94void
95_mesa_add_renderbuffer(struct gl_framebuffer *fb,
96                       gl_buffer_index bufferName, struct gl_renderbuffer *rb)
97{
98   assert(fb);
99   assert(rb);
100   assert(bufferName < BUFFER_COUNT);
101
102   /* There should be no previous renderbuffer on this attachment point,
103    * with the exception of depth/stencil since the same renderbuffer may
104    * be used for both.
105    */
106   assert(bufferName == BUFFER_DEPTH ||
107          bufferName == BUFFER_STENCIL ||
108          fb->Attachment[bufferName].Renderbuffer == NULL);
109
110   /* winsys vs. user-created buffer cross check */
111   if (_mesa_is_user_fbo(fb)) {
112      assert(rb->Name);
113   }
114   else {
115      assert(!rb->Name);
116   }
117
118   fb->Attachment[bufferName].Type = GL_RENDERBUFFER_EXT;
119   fb->Attachment[bufferName].Complete = GL_TRUE;
120   _mesa_reference_renderbuffer(&fb->Attachment[bufferName].Renderbuffer, rb);
121}
122
123
124/**
125 * Remove the named renderbuffer from the given framebuffer.
126 * \param bufferName  one of the BUFFER_x tokens
127 */
128void
129_mesa_remove_renderbuffer(struct gl_framebuffer *fb,
130                          gl_buffer_index bufferName)
131{
132   assert(bufferName < BUFFER_COUNT);
133   _mesa_reference_renderbuffer(&fb->Attachment[bufferName].Renderbuffer,
134                                NULL);
135}
136
137
138/**
139 * Set *ptr to point to rb.  If *ptr points to another renderbuffer,
140 * dereference that buffer first.  The new renderbuffer's refcount will
141 * be incremented.  The old renderbuffer's refcount will be decremented.
142 * This is normally only called from the _mesa_reference_renderbuffer() macro
143 * when there's a real pointer change.
144 */
145void
146_mesa_reference_renderbuffer_(struct gl_renderbuffer **ptr,
147                              struct gl_renderbuffer *rb)
148{
149   if (*ptr) {
150      /* Unreference the old renderbuffer */
151      GLboolean deleteFlag = GL_FALSE;
152      struct gl_renderbuffer *oldRb = *ptr;
153
154      _glthread_LOCK_MUTEX(oldRb->Mutex);
155      ASSERT(oldRb->RefCount > 0);
156      oldRb->RefCount--;
157      /*printf("RB DECR %p (%d) to %d\n", (void*) oldRb, oldRb->Name, oldRb->RefCount);*/
158      deleteFlag = (oldRb->RefCount == 0);
159      _glthread_UNLOCK_MUTEX(oldRb->Mutex);
160
161      if (deleteFlag) {
162         GET_CURRENT_CONTEXT(ctx);
163         oldRb->Delete(ctx, oldRb);
164      }
165
166      *ptr = NULL;
167   }
168   assert(!*ptr);
169
170   if (rb) {
171      /* reference new renderbuffer */
172      _glthread_LOCK_MUTEX(rb->Mutex);
173      rb->RefCount++;
174      /*printf("RB INCR %p (%d) to %d\n", (void*) rb, rb->Name, rb->RefCount);*/
175      _glthread_UNLOCK_MUTEX(rb->Mutex);
176      *ptr = rb;
177   }
178}
179