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
  96 extern void
  97 _mesa_renderbuffer_storage(struct gl_context *ctx, struct gl_renderbuffer *rb,
  98                            GLenum internalFormat, GLsizei width,
  99                            GLsizei height, GLsizei samples);
 100
 101 extern void
 102 _mesa_validate_framebuffer(struct gl_context *ctx, struct gl_framebuffer *fb);
 103
 104 extern GLboolean
 105 _mesa_has_depthstencil_combined(const struct gl_framebuffer *fb);
 106
 107 extern void
 108 _mesa_test_framebuffer_completeness(struct gl_context *ctx,
 109                                     struct gl_framebuffer *fb);
 110
 111 extern GLboolean
 112 _mesa_is_legal_color_format(const struct gl_context *ctx, GLenum baseFormat);
 113
 114 extern GLenum
 115 _mesa_base_fbo_format(struct gl_context *ctx, GLenum internalFormat);
 116
 117 extern bool
 118 _mesa_detach_renderbuffer(struct gl_context *ctx,
 119                           struct gl_framebuffer *fb,
 120                           const void *att);
 121
 122 extern struct gl_renderbuffer_attachment *
 123 _mesa_get_and_validate_attachment(struct gl_context *ctx,
 124                                   struct gl_framebuffer *fb,
 125                                   GLenum attachment, const char *caller);
 126
 127 extern void
 128 _mesa_framebuffer_texture(struct gl_context *ctx, struct gl_framebuffer *fb,
 129                           GLenum attachment,
 130                           struct gl_renderbuffer_attachment *att,
 131                           struct gl_texture_object *texObj, GLenum textarget,
 132                           GLint level, GLuint layer, GLboolean layered);
 133
 134 extern GLenum
 135 _mesa_check_framebuffer_status(struct gl_context *ctx,
 136                                struct gl_framebuffer *fb);
 137
 138 extern void
 139 _mesa_bind_framebuffers(struct gl_context *ctx,
 140                         struct gl_framebuffer *newDrawFb,
 141                         struct gl_framebuffer *newReadFb);
 142
 143 extern GLboolean GLAPIENTRY
 144 _mesa_IsRenderbuffer(GLuint renderbuffer);
 145
 146 extern void GLAPIENTRY
 147 _mesa_BindRenderbuffer(GLenum target, GLuint renderbuffer);
 148
 149 extern void GLAPIENTRY
 150 _mesa_BindRenderbufferEXT(GLenum target, GLuint renderbuffer);
 151
 152 extern void GLAPIENTRY
 153 _mesa_DeleteRenderbuffers(GLsizei n, const GLuint *renderbuffers);
 154
 155 void GLAPIENTRY
 156 _mesa_GenRenderbuffers_no_error(GLsizei n, GLuint *renderbuffers);
 157
 158 extern void GLAPIENTRY
 159 _mesa_GenRenderbuffers(GLsizei n, GLuint *renderbuffers);
 160
 161 void GLAPIENTRY
 162 _mesa_CreateRenderbuffers_no_error(GLsizei n, GLuint *renderbuffers);
 163
 164 extern void GLAPIENTRY
 165 _mesa_CreateRenderbuffers(GLsizei n, GLuint *renderbuffers);
 166
 167 extern void GLAPIENTRY
 168 _mesa_RenderbufferStorage(GLenum target, GLenum internalformat,
 169                              GLsizei width, GLsizei height);
 170
 171 extern void GLAPIENTRY
 172 _mesa_RenderbufferStorageMultisample(GLenum target, GLsizei samples,
 173                                      GLenum internalformat,
 174                                      GLsizei width, GLsizei height);
 175
 176 extern void GLAPIENTRY
 177 _es_RenderbufferStorageEXT(GLenum target, GLenum internalFormat,
 178                            GLsizei width, GLsizei height);
 179
 180 extern void GLAPIENTRY
 181 _mesa_NamedRenderbufferStorage(GLuint renderbuffer, GLenum internalformat,
 182                                GLsizei width, GLsizei height);
 183
 184 extern void GLAPIENTRY
 185 _mesa_NamedRenderbufferStorageMultisample(GLuint renderbuffer, GLsizei samples,
 186                                           GLenum internalformat,
 187                                           GLsizei width, GLsizei height);
 188
 189 extern void GLAPIENTRY
 190 _mesa_EGLImageTargetRenderbufferStorageOES(GLenum target, GLeglImageOES image);
 191
 192 extern void GLAPIENTRY
 193 _mesa_GetRenderbufferParameteriv(GLenum target, GLenum pname,
 194                                     GLint *params);
 195
 196 void GLAPIENTRY
 197 _mesa_GetNamedRenderbufferParameteriv(GLuint renderbuffer, GLenum pname,
 198                                       GLint *params);
 199
 200 extern GLboolean GLAPIENTRY
 201 _mesa_IsFramebuffer(GLuint framebuffer);
 202
 203 extern void GLAPIENTRY
 204 _mesa_BindFramebuffer(GLenum target, GLuint framebuffer);
 205
 206 extern void GLAPIENTRY
 207 _mesa_BindFramebufferEXT(GLenum target, GLuint framebuffer);
 208
 209 extern void GLAPIENTRY
 210 _mesa_DeleteFramebuffers(GLsizei n, const GLuint *framebuffers);
 211
 212 extern void GLAPIENTRY
 213 _mesa_GenFramebuffers(GLsizei n, GLuint *framebuffers);
 214
 215 extern void GLAPIENTRY
 216 _mesa_CreateFramebuffers(GLsizei n, GLuint *framebuffers);
 217
 218 GLenum GLAPIENTRY
 219 _mesa_CheckFramebufferStatus_no_error(GLenum target);
 220
 221 extern GLenum GLAPIENTRY
 222 _mesa_CheckFramebufferStatus(GLenum target);
 223
 224 extern GLenum GLAPIENTRY
 225 _mesa_CheckNamedFramebufferStatus(GLuint framebuffer, GLenum target);
 226
 227 extern void GLAPIENTRY
 228 _mesa_FramebufferTexture1D_no_error(GLenum target, GLenum attachment,
 229                                     GLenum textarget, GLuint texture,
 230                                     GLint level);
 231 extern void GLAPIENTRY
 232 _mesa_FramebufferTexture1D(GLenum target, GLenum attachment,
 233                               GLenum textarget, GLuint texture, GLint level);
 234
 235 extern void GLAPIENTRY
 236 _mesa_FramebufferTexture2D_no_error(GLenum target, GLenum attachment,
 237                                     GLenum textarget, GLuint texture,
 238                                     GLint level);
 239 extern void GLAPIENTRY
 240 _mesa_FramebufferTexture2D(GLenum target, GLenum attachment,
 241                               GLenum textarget, GLuint texture, GLint level);
 242
 243 extern void GLAPIENTRY
 244 _mesa_FramebufferTexture3D_no_error(GLenum target, GLenum attachment,
 245                                     GLenum textarget, GLuint texture,
 246                                     GLint level, GLint layer);
 247 extern void GLAPIENTRY
 248 _mesa_FramebufferTexture3D(GLenum target, GLenum attachment,
 249                               GLenum textarget, GLuint texture,
 250                               GLint level, GLint layer);
 251
 252 extern void GLAPIENTRY
 253 _mesa_FramebufferTextureLayer_no_error(GLenum target, GLenum attachment,
 254                                        GLuint texture, GLint level,
 255                                        GLint layer);
 256 extern void GLAPIENTRY
 257 _mesa_FramebufferTextureLayer(GLenum target, GLenum attachment,
 258                                  GLuint texture, GLint level, GLint layer);
 259
 260 extern void GLAPIENTRY
 261 _mesa_NamedFramebufferTextureLayer_no_error(GLuint framebuffer,
 262                                             GLenum attachment,
 263                                             GLuint texture, GLint level,
 264                                             GLint layer);
 265 extern void GLAPIENTRY
 266 _mesa_NamedFramebufferTextureLayer(GLuint framebuffer, GLenum attachment,
 267                                    GLuint texture, GLint level, GLint layer);
 268
 269 extern void GLAPIENTRY
 270 _mesa_FramebufferTexture_no_error(GLenum target, GLenum attachment,
 271                                   GLuint texture, GLint level);
 272 extern void GLAPIENTRY
 273 _mesa_FramebufferTexture(GLenum target, GLenum attachment,
 274                          GLuint texture, GLint level);
 275
 276 extern void GLAPIENTRY
 277 _mesa_NamedFramebufferTexture_no_error(GLuint framebuffer, GLenum attachment,
 278                                        GLuint texture, GLint level);
 279 extern void GLAPIENTRY
 280 _mesa_NamedFramebufferTexture(GLuint framebuffer, GLenum attachment,
 281                               GLuint texture, GLint level);
 282
 283 void GLAPIENTRY
 284 _mesa_FramebufferRenderbuffer_no_error(GLenum target, GLenum attachment,
 285                                        GLenum renderbuffertarget,
 286                                        GLuint renderbuffer);
 287
 288 extern void GLAPIENTRY
 289 _mesa_FramebufferRenderbuffer(GLenum target, GLenum attachment,
 290                                  GLenum renderbuffertarget,
 291                                  GLuint renderbuffer);
 292
 293 void GLAPIENTRY
 294 _mesa_NamedFramebufferRenderbuffer_no_error(GLuint framebuffer,
 295                                             GLenum attachment,
 296                                             GLenum renderbuffertarget,
 297                                             GLuint renderbuffer);
 298
 299 extern void GLAPIENTRY
 300 _mesa_NamedFramebufferRenderbuffer(GLuint framebuffer, GLenum attachment,
 301                                    GLenum renderbuffertarget,
 302                                    GLuint renderbuffer);
 303
 304 extern void GLAPIENTRY
 305 _mesa_GetFramebufferAttachmentParameteriv(GLenum target, GLenum attachment,
 306                                              GLenum pname, GLint *params);
 307 extern void GLAPIENTRY
 308 _mesa_GetNamedFramebufferAttachmentParameteriv(GLuint framebuffer,
 309                                                GLenum attachment,
 310                                                GLenum pname, GLint *params);
 311
 312 extern void GLAPIENTRY
 313 _mesa_NamedFramebufferParameteri(GLuint framebuffer, GLenum pname,
 314                                  GLint param);
 315
 316 extern void GLAPIENTRY
 317 _mesa_GetNamedFramebufferParameteriv(GLuint framebuffer, GLenum pname,
 318                                      GLint *param);
 319
 320 void GLAPIENTRY
 321 _mesa_InvalidateSubFramebuffer_no_error(GLenum target, GLsizei numAttachments,
 322                                         const GLenum *attachments, GLint x,
 323                                         GLint y, GLsizei width, GLsizei height);
 324
 325 extern void GLAPIENTRY
 326 _mesa_InvalidateSubFramebuffer(GLenum target, GLsizei numAttachments,
 327                                const GLenum *attachments, GLint x, GLint y,
 328                                GLsizei width, GLsizei height);
 329
 330 extern void GLAPIENTRY
 331 _mesa_InvalidateNamedFramebufferSubData(GLuint framebuffer,
 332                                         GLsizei numAttachments,
 333                                         const GLenum *attachments,
 334                                         GLint x, GLint y,
 335                                         GLsizei width, GLsizei height);
 336 void GLAPIENTRY
 337 _mesa_InvalidateFramebuffer_no_error(GLenum target, GLsizei numAttachments,
 338                                      const GLenum *attachments);
 339
 340 extern void GLAPIENTRY
 341 _mesa_InvalidateFramebuffer(GLenum target, GLsizei numAttachments,
 342                             const GLenum *attachments);
 343
 344 extern void GLAPIENTRY
 345 _mesa_InvalidateNamedFramebufferData(GLuint framebuffer,
 346                                      GLsizei numAttachments,
 347                                      const GLenum *attachments);
 348
 349 extern void GLAPIENTRY
 350 _mesa_DiscardFramebufferEXT(GLenum target, GLsizei numAttachments,
 351                             const GLenum *attachments);
 352
 353 extern void GLAPIENTRY
 354 _mesa_FramebufferParameteri(GLenum target, GLenum pname, GLint param);
 355
 356 extern void GLAPIENTRY
 357 _mesa_GetFramebufferParameteriv(GLenum target, GLenum pname, GLint *params);
 358
 359 #endif /* FBOBJECT_H */