src/mesa/main/fbobject.h

   1 /*
   2  * Mesa 3-D graphics library
   3  * Version:  7.1
   4  *
   5  * Copyright (C) 1999-2008  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  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
  21  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  22  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  23  * OTHER DEALINGS IN THE SOFTWARE.
  24  */
  25
  26
  27 #ifndef FBOBJECT_H
  28 #define FBOBJECT_H
  29
  30 #include "compiler.h"
  31 #include "glheader.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_framebuffer *
  68 _mesa_lookup_framebuffer(struct gl_context *ctx, GLuint id);
  69
  70 extern struct gl_renderbuffer_attachment *
  71 _mesa_get_attachment(struct gl_context *ctx, struct gl_framebuffer *fb,
  72                      GLenum attachment);
  73
  74
  75 /** Return the texture image for a renderbuffer attachment */
  76 static inline struct gl_texture_image *
  77 _mesa_get_attachment_teximage(struct gl_renderbuffer_attachment *att)
  78 {
  79    assert(att->Type == GL_TEXTURE);
  80    return att->Texture->Image[att->CubeMapFace][att->TextureLevel];
  81 }
  82
  83
  84 /** Return the (const) texture image for a renderbuffer attachment */
  85 static inline const struct gl_texture_image *
  86 _mesa_get_attachment_teximage_const(const struct gl_renderbuffer_attachment *att)
  87 {
  88    assert(att->Type == GL_TEXTURE);
  89    return att->Texture->Image[att->CubeMapFace][att->TextureLevel];
  90 }
  91
  92
  93 extern void
  94 _mesa_remove_attachment(struct gl_context *ctx,
  95                         struct gl_renderbuffer_attachment *att);
  96
  97 extern void
  98 _mesa_set_texture_attachment(struct gl_context *ctx,
  99                              struct gl_framebuffer *fb,
 100                              struct gl_renderbuffer_attachment *att,
 101                              struct gl_texture_object *texObj,
 102                              GLenum texTarget, GLuint level, GLuint zoffset,
 103                              GLboolean layered);
 104
 105 extern void
 106 _mesa_set_renderbuffer_attachment(struct gl_context *ctx,
 107                                   struct gl_renderbuffer_attachment *att,
 108                                   struct gl_renderbuffer *rb);
 109
 110 extern void
 111 _mesa_framebuffer_renderbuffer(struct gl_context *ctx,
 112                                struct gl_framebuffer *fb,
 113                                GLenum attachment, struct gl_renderbuffer *rb);
 114
 115 extern void
 116 _mesa_validate_framebuffer(struct gl_context *ctx, struct gl_framebuffer *fb);
 117
 118 extern GLboolean
 119 _mesa_has_depthstencil_combined(const struct gl_framebuffer *fb);
 120
 121 extern void
 122 _mesa_test_framebuffer_completeness(struct gl_context *ctx,
 123                                     struct gl_framebuffer *fb);
 124
 125 extern GLboolean
 126 _mesa_is_legal_color_format(const struct gl_context *ctx, GLenum baseFormat);
 127
 128 extern GLenum
 129 _mesa_base_fbo_format(struct gl_context *ctx, GLenum internalFormat);
 130
 131 extern GLboolean GLAPIENTRY
 132 _mesa_IsRenderbuffer(GLuint renderbuffer);
 133
 134 extern void GLAPIENTRY
 135 _mesa_BindRenderbuffer(GLenum target, GLuint renderbuffer);
 136
 137 extern void GLAPIENTRY
 138 _mesa_DeleteRenderbuffers(GLsizei n, const GLuint *renderbuffers);
 139
 140 extern void GLAPIENTRY
 141 _mesa_GenRenderbuffers(GLsizei n, GLuint *renderbuffers);
 142
 143 extern void GLAPIENTRY
 144 _mesa_RenderbufferStorage(GLenum target, GLenum internalformat,
 145                              GLsizei width, GLsizei height);
 146
 147 extern void GLAPIENTRY
 148 _mesa_RenderbufferStorageMultisample(GLenum target, GLsizei samples,
 149                                      GLenum internalformat,
 150                                      GLsizei width, GLsizei height);
 151
 152 extern void GLAPIENTRY
 153 _es_RenderbufferStorageEXT(GLenum target, GLenum internalFormat,
 154                            GLsizei width, GLsizei height);
 155
 156 extern void GLAPIENTRY
 157 _mesa_EGLImageTargetRenderbufferStorageOES(GLenum target, GLeglImageOES image);
 158
 159 extern void GLAPIENTRY
 160 _mesa_GetRenderbufferParameteriv(GLenum target, GLenum pname,
 161                                     GLint *params);
 162
 163 extern GLboolean GLAPIENTRY
 164 _mesa_IsFramebuffer(GLuint framebuffer);
 165
 166 extern void GLAPIENTRY
 167 _mesa_BindFramebuffer(GLenum target, GLuint framebuffer);
 168
 169 extern void GLAPIENTRY
 170 _mesa_DeleteFramebuffers(GLsizei n, const GLuint *framebuffers);
 171
 172 extern void GLAPIENTRY
 173 _mesa_GenFramebuffers(GLsizei n, GLuint *framebuffers);
 174
 175 extern GLenum GLAPIENTRY
 176 _mesa_CheckFramebufferStatus(GLenum target);
 177
 178 extern void GLAPIENTRY
 179 _mesa_FramebufferTexture1D(GLenum target, GLenum attachment,
 180                               GLenum textarget, GLuint texture, GLint level);
 181
 182 extern void GLAPIENTRY
 183 _mesa_FramebufferTexture2D(GLenum target, GLenum attachment,
 184                               GLenum textarget, GLuint texture, GLint level);
 185
 186 extern void GLAPIENTRY
 187 _mesa_FramebufferTexture3D(GLenum target, GLenum attachment,
 188                               GLenum textarget, GLuint texture,
 189                               GLint level, GLint zoffset);
 190
 191 extern void GLAPIENTRY
 192 _mesa_FramebufferTextureLayer(GLenum target, GLenum attachment,
 193                                  GLuint texture, GLint level, GLint layer);
 194
 195 extern void GLAPIENTRY
 196 _mesa_FramebufferTexture(GLenum target, GLenum attachment,
 197                          GLuint texture, GLint level);
 198
 199 extern void GLAPIENTRY
 200 _mesa_FramebufferRenderbuffer(GLenum target, GLenum attachment,
 201                                  GLenum renderbuffertarget,
 202                                  GLuint renderbuffer);
 203
 204 extern void GLAPIENTRY
 205 _mesa_GetFramebufferAttachmentParameteriv(GLenum target, GLenum attachment,
 206                                              GLenum pname, GLint *params);
 207
 208 extern void GLAPIENTRY
 209 _mesa_GenerateMipmap(GLenum target);
 210
 211
 212 extern void GLAPIENTRY
 213 _mesa_BlitFramebuffer(GLint srcX0, GLint srcY0, GLint srcX1, GLint srcY1,
 214                          GLint dstX0, GLint dstY0, GLint dstX1, GLint dstY1,
 215                          GLbitfield mask, GLenum filter);
 216
 217 extern void GLAPIENTRY
 218 _mesa_InvalidateSubFramebuffer(GLenum target, GLsizei numAttachments,
 219                                const GLenum *attachments, GLint x, GLint y,
 220                                GLsizei width, GLsizei height);
 221
 222 extern void GLAPIENTRY
 223 _mesa_InvalidateFramebuffer(GLenum target, GLsizei numAttachments,
 224                             const GLenum *attachments);
 225
 226 extern void GLAPIENTRY
 227 _mesa_DiscardFramebufferEXT(GLenum target, GLsizei numAttachments,
 228                             const GLenum *attachments);
 229
 230 #endif /* FBOBJECT_H */