src/mesa/main/framebuffer.h

   1 /*
   2  * Mesa 3-D graphics library
   3  *
   4  * Copyright (C) 1999-2006  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 FRAMEBUFFER_H
  27 #define FRAMEBUFFER_H
  28
  29 #include "glheader.h"
  30
  31 struct gl_config;
  32 struct gl_context;
  33 struct gl_renderbuffer;
  34
  35 extern struct gl_framebuffer *
  36 _mesa_create_framebuffer(const struct gl_config *visual);
  37
  38 extern struct gl_framebuffer *
  39 _mesa_new_framebuffer(struct gl_context *ctx, GLuint name);
  40
  41 extern void
  42 _mesa_initialize_window_framebuffer(struct gl_framebuffer *fb,
  43                                      const struct gl_config *visual);
  44
  45 extern void
  46 _mesa_initialize_user_framebuffer(struct gl_framebuffer *fb, GLuint name);
  47
  48 extern void
  49 _mesa_destroy_framebuffer(struct gl_framebuffer *buffer);
  50
  51 extern void
  52 _mesa_free_framebuffer_data(struct gl_framebuffer *buffer);
  53
  54 extern void
  55 _mesa_reference_framebuffer_(struct gl_framebuffer **ptr,
  56                              struct gl_framebuffer *fb);
  57
  58 static inline void
  59 _mesa_reference_framebuffer(struct gl_framebuffer **ptr,
  60                             struct gl_framebuffer *fb)
  61 {
  62    if (*ptr != fb)
  63       _mesa_reference_framebuffer_(ptr, fb);
  64 }
  65
  66 extern void
  67 _mesa_resize_framebuffer(struct gl_context *ctx, struct gl_framebuffer *fb,
  68                          GLuint width, GLuint height);
  69
  70
  71 extern void
  72 _mesa_resizebuffers( struct gl_context *ctx );
  73
  74 extern void
  75 _mesa_scissor_bounding_box(const struct gl_context *ctx,
  76                            const struct gl_framebuffer *buffer,
  77                            unsigned idx, int *bbox);
  78 extern void
  79 _mesa_intersect_scissor_bounding_box(const struct gl_context *ctx,
  80                                      unsigned idx, int *bbox);
  81
  82 static inline GLuint
  83 _mesa_geometric_width(const struct gl_framebuffer *buffer)
  84 {
  85    return buffer->_HasAttachments ?
  86       buffer->Width : buffer->DefaultGeometry.Width;
  87 }
  88
  89 static inline GLuint
  90 _mesa_geometric_height(const struct gl_framebuffer *buffer)
  91 {
  92    return buffer->_HasAttachments ?
  93       buffer->Height : buffer->DefaultGeometry.Height;
  94 }
  95
  96 static inline GLuint
  97 _mesa_geometric_samples(const struct gl_framebuffer *buffer)
  98 {
  99    return buffer->_HasAttachments ?
 100       buffer->Visual.samples : buffer->DefaultGeometry.NumSamples;
 101 }
 102
 103 static inline GLuint
 104 _mesa_geometric_layers(const struct gl_framebuffer *buffer)
 105 {
 106    return buffer->_HasAttachments ?
 107       buffer->MaxNumLayers : buffer->DefaultGeometry.Layers;
 108 }
 109
 110 extern void
 111 _mesa_update_draw_buffer_bounds(struct gl_context *ctx,
 112                                 struct gl_framebuffer *drawFb);
 113
 114 extern void
 115 _mesa_update_framebuffer_visual(struct gl_context *ctx,
 116                                 struct gl_framebuffer *fb);
 117
 118 extern void
 119 _mesa_update_framebuffer(struct gl_context *ctx,
 120                          struct gl_framebuffer *readFb,
 121                          struct gl_framebuffer *drawFb);
 122
 123 extern GLboolean
 124 _mesa_source_buffer_exists(struct gl_context *ctx, GLenum format);
 125
 126 extern GLboolean
 127 _mesa_dest_buffer_exists(struct gl_context *ctx, GLenum format);
 128
 129 extern GLenum
 130 _mesa_get_color_read_type(struct gl_context *ctx);
 131
 132 extern GLenum
 133 _mesa_get_color_read_format(struct gl_context *ctx);
 134
 135 extern struct gl_renderbuffer *
 136 _mesa_get_read_renderbuffer_for_format(const struct gl_context *ctx,
 137                                        GLenum format);
 138
 139 extern void
 140 _mesa_print_framebuffer(const struct gl_framebuffer *fb);
 141
 142 #endif /* FRAMEBUFFER_H */