871a2cc280ec235c1be31bd12e85f653cef78935
[mesa.git] / src / mesa / main / fbobject.h
1 /*
2 * Mesa 3-D graphics library
3 *
4 * Copyright (C) 1999-2008 Brian Paul All Rights Reserved.
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the "Software"),
8 * to deal in the Software without restriction, including without limitation
9 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 * and/or sell copies of the Software, and to permit persons to whom the
11 * Software is furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included
14 * in all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
17 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
20 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
22 * OTHER DEALINGS IN THE SOFTWARE.
23 */
24
25
26 #ifndef FBOBJECT_H
27 #define FBOBJECT_H
28
29 #include "compiler.h"
30 #include "glheader.h"
31 #include <stdbool.h>
32
33 struct gl_context;
34 struct gl_texture_object;
35
36
37 /**
38 * Is the given FBO a user-created FBO?
39 */
40 static inline GLboolean
41 _mesa_is_user_fbo(const struct gl_framebuffer *fb)
42 {
43 return fb->Name != 0;
44 }
45
46
47 /**
48 * Is the given FBO a window system FBO (like an X window)?
49 */
50 static inline GLboolean
51 _mesa_is_winsys_fbo(const struct gl_framebuffer *fb)
52 {
53 return fb->Name == 0;
54 }
55
56
57
58 extern void
59 _mesa_init_fbobjects(struct gl_context *ctx);
60
61 extern struct gl_framebuffer *
62 _mesa_get_incomplete_framebuffer(void);
63
64 extern struct gl_renderbuffer *
65 _mesa_lookup_renderbuffer(struct gl_context *ctx, GLuint id);
66
67 extern struct gl_renderbuffer *
68 _mesa_lookup_renderbuffer_err(struct gl_context *ctx, GLuint id,
69 const char *func);
70
71 extern struct gl_framebuffer *
72 _mesa_lookup_framebuffer(struct gl_context *ctx, GLuint id);
73
74 extern struct gl_framebuffer *
75 _mesa_lookup_framebuffer_err(struct gl_context *ctx, GLuint id,
76 const char *func);
77
78
79 void
80 _mesa_update_texture_renderbuffer(struct gl_context *ctx,
81 struct gl_framebuffer *fb,
82 struct gl_renderbuffer_attachment *att);
83
84 extern void
85 _mesa_FramebufferRenderbuffer_sw(struct gl_context *ctx,
86 struct gl_framebuffer *fb,
87 GLenum attachment,
88 struct gl_renderbuffer *rb);
89
90 extern void
91 _mesa_framebuffer_renderbuffer(struct gl_context *ctx,
92 struct gl_framebuffer *fb,
93 GLenum attachment,
94 struct gl_renderbuffer *rb,
95 const char *func);
96
97 extern void
98 _mesa_validate_framebuffer(struct gl_context *ctx, struct gl_framebuffer *fb);
99
100 extern GLboolean
101 _mesa_has_depthstencil_combined(const struct gl_framebuffer *fb);
102
103 extern void
104 _mesa_test_framebuffer_completeness(struct gl_context *ctx,
105 struct gl_framebuffer *fb);
106
107 extern GLboolean
108 _mesa_is_legal_color_format(const struct gl_context *ctx, GLenum baseFormat);
109
110 extern GLenum
111 _mesa_base_fbo_format(struct gl_context *ctx, GLenum internalFormat);
112
113 extern bool
114 _mesa_detach_renderbuffer(struct gl_context *ctx,
115 struct gl_framebuffer *fb,
116 const void *att);
117
118 extern void
119 _mesa_framebuffer_texture(struct gl_context *ctx, struct gl_framebuffer *fb,
120 GLenum attachment,
121 struct gl_texture_object *texObj, GLenum textarget,
122 GLint level, GLuint layer, GLboolean layered,
123 const char *caller);
124
125 extern GLenum
126 _mesa_check_framebuffer_status(struct gl_context *ctx,
127 struct gl_framebuffer *fb);
128
129
130 extern GLboolean GLAPIENTRY
131 _mesa_IsRenderbuffer(GLuint renderbuffer);
132
133 extern void GLAPIENTRY
134 _mesa_BindRenderbuffer(GLenum target, GLuint renderbuffer);
135
136 extern void GLAPIENTRY
137 _mesa_BindRenderbufferEXT(GLenum target, GLuint renderbuffer);
138
139 extern void GLAPIENTRY
140 _mesa_DeleteRenderbuffers(GLsizei n, const GLuint *renderbuffers);
141
142 extern void GLAPIENTRY
143 _mesa_GenRenderbuffers(GLsizei n, GLuint *renderbuffers);
144
145 extern void GLAPIENTRY
146 _mesa_CreateRenderbuffers(GLsizei n, GLuint *renderbuffers);
147
148 extern void GLAPIENTRY
149 _mesa_RenderbufferStorage(GLenum target, GLenum internalformat,
150 GLsizei width, GLsizei height);
151
152 extern void GLAPIENTRY
153 _mesa_RenderbufferStorageMultisample(GLenum target, GLsizei samples,
154 GLenum internalformat,
155 GLsizei width, GLsizei height);
156
157 extern void GLAPIENTRY
158 _es_RenderbufferStorageEXT(GLenum target, GLenum internalFormat,
159 GLsizei width, GLsizei height);
160
161 extern void GLAPIENTRY
162 _mesa_NamedRenderbufferStorage(GLuint renderbuffer, GLenum internalformat,
163 GLsizei width, GLsizei height);
164
165 extern void GLAPIENTRY
166 _mesa_NamedRenderbufferStorageMultisample(GLuint renderbuffer, GLsizei samples,
167 GLenum internalformat,
168 GLsizei width, GLsizei height);
169
170 extern void GLAPIENTRY
171 _mesa_EGLImageTargetRenderbufferStorageOES(GLenum target, GLeglImageOES image);
172
173 extern void GLAPIENTRY
174 _mesa_GetRenderbufferParameteriv(GLenum target, GLenum pname,
175 GLint *params);
176
177 void GLAPIENTRY
178 _mesa_GetNamedRenderbufferParameteriv(GLuint renderbuffer, GLenum pname,
179 GLint *params);
180
181 extern GLboolean GLAPIENTRY
182 _mesa_IsFramebuffer(GLuint framebuffer);
183
184 extern void GLAPIENTRY
185 _mesa_BindFramebuffer(GLenum target, GLuint framebuffer);
186
187 extern void GLAPIENTRY
188 _mesa_BindFramebufferEXT(GLenum target, GLuint framebuffer);
189
190 extern void GLAPIENTRY
191 _mesa_DeleteFramebuffers(GLsizei n, const GLuint *framebuffers);
192
193 extern void GLAPIENTRY
194 _mesa_GenFramebuffers(GLsizei n, GLuint *framebuffers);
195
196 extern void GLAPIENTRY
197 _mesa_CreateFramebuffers(GLsizei n, GLuint *framebuffers);
198
199 extern GLenum GLAPIENTRY
200 _mesa_CheckFramebufferStatus(GLenum target);
201
202 extern GLenum GLAPIENTRY
203 _mesa_CheckNamedFramebufferStatus(GLuint framebuffer, GLenum target);
204
205 extern void GLAPIENTRY
206 _mesa_FramebufferTexture1D(GLenum target, GLenum attachment,
207 GLenum textarget, GLuint texture, GLint level);
208
209 extern void GLAPIENTRY
210 _mesa_FramebufferTexture2D(GLenum target, GLenum attachment,
211 GLenum textarget, GLuint texture, GLint level);
212
213 extern void GLAPIENTRY
214 _mesa_FramebufferTexture3D(GLenum target, GLenum attachment,
215 GLenum textarget, GLuint texture,
216 GLint level, GLint layer);
217
218 extern void GLAPIENTRY
219 _mesa_FramebufferTextureLayer(GLenum target, GLenum attachment,
220 GLuint texture, GLint level, GLint layer);
221
222 extern void GLAPIENTRY
223 _mesa_NamedFramebufferTextureLayer(GLuint framebuffer, GLenum attachment,
224 GLuint texture, GLint level, GLint layer);
225
226 extern void GLAPIENTRY
227 _mesa_FramebufferTexture(GLenum target, GLenum attachment,
228 GLuint texture, GLint level);
229
230 extern void GLAPIENTRY
231 _mesa_NamedFramebufferTexture(GLuint framebuffer, GLenum attachment,
232 GLuint texture, GLint level);
233
234 extern void GLAPIENTRY
235 _mesa_FramebufferRenderbuffer(GLenum target, GLenum attachment,
236 GLenum renderbuffertarget,
237 GLuint renderbuffer);
238
239 extern void GLAPIENTRY
240 _mesa_NamedFramebufferRenderbuffer(GLuint framebuffer, GLenum attachment,
241 GLenum renderbuffertarget,
242 GLuint renderbuffer);
243
244 extern void GLAPIENTRY
245 _mesa_GetFramebufferAttachmentParameteriv(GLenum target, GLenum attachment,
246 GLenum pname, GLint *params);
247
248 extern void GLAPIENTRY
249 _mesa_InvalidateSubFramebuffer(GLenum target, GLsizei numAttachments,
250 const GLenum *attachments, GLint x, GLint y,
251 GLsizei width, GLsizei height);
252
253 extern void GLAPIENTRY
254 _mesa_InvalidateFramebuffer(GLenum target, GLsizei numAttachments,
255 const GLenum *attachments);
256
257 extern void GLAPIENTRY
258 _mesa_DiscardFramebufferEXT(GLenum target, GLsizei numAttachments,
259 const GLenum *attachments);
260
261 #endif /* FBOBJECT_H */