bb8f46d11eb4ab8312a9351271a0151900579c88
[mesa.git] / src / mesa / main / renderbuffer.c
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 */
39 static void *
40 nop_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 */
49 void
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->PutValues = NULL;
82 }
83
84
85 /**
86 * Allocate a new gl_renderbuffer object. This can be used for user-created
87 * renderbuffers or window-system renderbuffers.
88 */
89 struct gl_renderbuffer *
90 _mesa_new_renderbuffer(struct gl_context *ctx, GLuint name)
91 {
92 struct gl_renderbuffer *rb = CALLOC_STRUCT(gl_renderbuffer);
93 if (rb) {
94 _mesa_init_renderbuffer(rb, name);
95 }
96 return rb;
97 }
98
99
100 /**
101 * Delete a gl_framebuffer.
102 * This is the default function for renderbuffer->Delete().
103 */
104 void
105 _mesa_delete_renderbuffer(struct gl_renderbuffer *rb)
106 {
107 if (rb->Data) {
108 free(rb->Data);
109 }
110 free(rb);
111 }
112
113
114 /**
115 * Attach a renderbuffer to a framebuffer.
116 * \param bufferName one of the BUFFER_x tokens
117 */
118 void
119 _mesa_add_renderbuffer(struct gl_framebuffer *fb,
120 gl_buffer_index bufferName, struct gl_renderbuffer *rb)
121 {
122 assert(fb);
123 assert(rb);
124 assert(bufferName < BUFFER_COUNT);
125
126 /* There should be no previous renderbuffer on this attachment point,
127 * with the exception of depth/stencil since the same renderbuffer may
128 * be used for both.
129 */
130 assert(bufferName == BUFFER_DEPTH ||
131 bufferName == BUFFER_STENCIL ||
132 fb->Attachment[bufferName].Renderbuffer == NULL);
133
134 /* winsys vs. user-created buffer cross check */
135 if (fb->Name) {
136 assert(rb->Name);
137 }
138 else {
139 assert(!rb->Name);
140 }
141
142 fb->Attachment[bufferName].Type = GL_RENDERBUFFER_EXT;
143 fb->Attachment[bufferName].Complete = GL_TRUE;
144 _mesa_reference_renderbuffer(&fb->Attachment[bufferName].Renderbuffer, rb);
145 }
146
147
148 /**
149 * Remove the named renderbuffer from the given framebuffer.
150 * \param bufferName one of the BUFFER_x tokens
151 */
152 void
153 _mesa_remove_renderbuffer(struct gl_framebuffer *fb,
154 gl_buffer_index bufferName)
155 {
156 assert(bufferName < BUFFER_COUNT);
157 _mesa_reference_renderbuffer(&fb->Attachment[bufferName].Renderbuffer,
158 NULL);
159 }
160
161
162 /**
163 * Set *ptr to point to rb. If *ptr points to another renderbuffer,
164 * dereference that buffer first. The new renderbuffer's refcount will
165 * be incremented. The old renderbuffer's refcount will be decremented.
166 * This is normally only called from the _mesa_reference_renderbuffer() macro
167 * when there's a real pointer change.
168 */
169 void
170 _mesa_reference_renderbuffer_(struct gl_renderbuffer **ptr,
171 struct gl_renderbuffer *rb)
172 {
173 if (*ptr) {
174 /* Unreference the old renderbuffer */
175 GLboolean deleteFlag = GL_FALSE;
176 struct gl_renderbuffer *oldRb = *ptr;
177
178 _glthread_LOCK_MUTEX(oldRb->Mutex);
179 ASSERT(oldRb->RefCount > 0);
180 oldRb->RefCount--;
181 /*printf("RB DECR %p (%d) to %d\n", (void*) oldRb, oldRb->Name, oldRb->RefCount);*/
182 deleteFlag = (oldRb->RefCount == 0);
183 _glthread_UNLOCK_MUTEX(oldRb->Mutex);
184
185 if (deleteFlag) {
186 oldRb->Delete(oldRb);
187 }
188
189 *ptr = NULL;
190 }
191 assert(!*ptr);
192
193 if (rb) {
194 /* reference new renderbuffer */
195 _glthread_LOCK_MUTEX(rb->Mutex);
196 rb->RefCount++;
197 /*printf("RB INCR %p (%d) to %d\n", (void*) rb, rb->Name, rb->RefCount);*/
198 _glthread_UNLOCK_MUTEX(rb->Mutex);
199 *ptr = rb;
200 }
201 }