intel: derive intel_renderbuffer from swrast_renderbuffer
[mesa.git] / src / mesa / drivers / dri / intel / intel_fbo.h
1 /**************************************************************************
2 *
3 * Copyright 2006 Tungsten Graphics, Inc., Cedar Park, Texas.
4 * 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
8 * "Software"), to deal in the Software without restriction, including
9 * without limitation the rights to use, copy, modify, merge, publish,
10 * distribute, sub license, and/or sell copies of the Software, and to
11 * permit persons to whom the Software is furnished to do so, subject to
12 * the following conditions:
13 *
14 * The above copyright notice and this permission notice (including the
15 * next paragraph) shall be included in all copies or substantial portions
16 * of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
21 * IN NO EVENT SHALL TUNGSTEN GRAPHICS AND/OR ITS SUPPLIERS BE LIABLE FOR
22 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
23 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
24 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
25 *
26 **************************************************************************/
27
28 #ifndef INTEL_FBO_H
29 #define INTEL_FBO_H
30
31 #include <stdbool.h>
32 #include <assert.h>
33 #include "main/formats.h"
34 #include "intel_context.h"
35 #include "intel_screen.h"
36
37 struct intel_context;
38 struct intel_mipmap_tree;
39 struct intel_texture_image;
40
41 /**
42 * Intel renderbuffer, derived from gl_renderbuffer.
43 */
44 struct intel_renderbuffer
45 {
46 struct swrast_renderbuffer Base;
47 struct intel_mipmap_tree *mt; /**< The renderbuffer storage. */
48 drm_intel_bo *map_bo;
49
50 /**
51 * \name Miptree view
52 * \{
53 *
54 * Multiple renderbuffers may simultaneously wrap a single texture and each
55 * provide a different view into that texture. The fields below indicate
56 * which miptree slice is wrapped by this renderbuffer. The fields' values
57 * are consistent with the 'level' and 'layer' parameters of
58 * glFramebufferTextureLayer().
59 *
60 * For renderbuffers not created with glFramebufferTexture*(), mt_level and
61 * mt_layer are 0.
62 */
63 unsigned int mt_level;
64 unsigned int mt_layer;
65 /** \} */
66
67 GLuint draw_x, draw_y; /**< Offset of drawing within the region */
68 };
69
70
71 /**
72 * gl_renderbuffer is a base class which we subclass. The Class field
73 * is used for simple run-time type checking.
74 */
75 #define INTEL_RB_CLASS 0x12345678
76
77
78 /**
79 * Return a gl_renderbuffer ptr casted to intel_renderbuffer.
80 * NULL will be returned if the rb isn't really an intel_renderbuffer.
81 * This is determined by checking the ClassID.
82 */
83 static INLINE struct intel_renderbuffer *
84 intel_renderbuffer(struct gl_renderbuffer *rb)
85 {
86 struct intel_renderbuffer *irb = (struct intel_renderbuffer *) rb;
87 if (irb && irb->Base.Base.ClassID == INTEL_RB_CLASS) {
88 /*_mesa_warning(NULL, "Returning non-intel Rb\n");*/
89 return irb;
90 }
91 else
92 return NULL;
93 }
94
95
96 /**
97 * \brief Return the framebuffer attachment specified by attIndex.
98 *
99 * If the framebuffer lacks the specified attachment, then return null.
100 *
101 * If the attached renderbuffer is a wrapper, then return wrapped
102 * renderbuffer.
103 */
104 static INLINE struct intel_renderbuffer *
105 intel_get_renderbuffer(struct gl_framebuffer *fb, gl_buffer_index attIndex)
106 {
107 struct gl_renderbuffer *rb;
108
109 assert((unsigned)attIndex < ARRAY_SIZE(fb->Attachment));
110
111 rb = fb->Attachment[attIndex].Renderbuffer;
112 if (!rb)
113 return NULL;
114
115 return intel_renderbuffer(rb);
116 }
117
118
119 static INLINE gl_format
120 intel_rb_format(const struct intel_renderbuffer *rb)
121 {
122 return rb->Base.Base.Format;
123 }
124
125
126 bool
127 intel_framebuffer_has_hiz(struct gl_framebuffer *fb);
128
129 extern struct intel_renderbuffer *
130 intel_create_renderbuffer(gl_format format);
131
132 struct gl_renderbuffer*
133 intel_create_wrapped_renderbuffer(struct gl_context * ctx,
134 int width, int height,
135 gl_format format);
136
137 GLboolean
138 intel_alloc_renderbuffer_storage(struct gl_context * ctx,
139 struct gl_renderbuffer *rb,
140 GLenum internalFormat,
141 GLuint width, GLuint height);
142
143 extern void
144 intel_fbo_init(struct intel_context *intel);
145
146
147 extern void
148 intel_flip_renderbuffers(struct gl_framebuffer *fb);
149
150 void
151 intel_renderbuffer_set_draw_offset(struct intel_renderbuffer *irb);
152
153 uint32_t
154 intel_renderbuffer_tile_offsets(struct intel_renderbuffer *irb,
155 uint32_t *tile_x,
156 uint32_t *tile_y);
157
158 struct intel_region*
159 intel_get_rb_region(struct gl_framebuffer *fb, GLuint attIndex);
160
161 void
162 intel_renderbuffer_set_needs_hiz_resolve(struct intel_renderbuffer *irb);
163
164 void
165 intel_renderbuffer_set_needs_depth_resolve(struct intel_renderbuffer *irb);
166
167
168 /**
169 * \brief Perform a HiZ resolve on the renderbuffer.
170 *
171 * It is safe to call this function on a renderbuffer without HiZ. In that
172 * case, the function is a no-op.
173 *
174 * \return false if no resolve was needed
175 */
176 bool
177 intel_renderbuffer_resolve_hiz(struct intel_context *intel,
178 struct intel_renderbuffer *irb);
179
180 /**
181 * \brief Perform a depth resolve on the renderbuffer.
182 *
183 * It is safe to call this function on a renderbuffer without HiZ. In that
184 * case, the function is a no-op.
185 *
186 * \return false if no resolve was needed
187 */
188 bool
189 intel_renderbuffer_resolve_depth(struct intel_context *intel,
190 struct intel_renderbuffer *irb);
191
192 #endif /* INTEL_FBO_H */