ilo: add ilo_buffer.h to core
[mesa.git] / src / gallium / drivers / ilo / ilo_resource.h
1 /*
2 * Mesa 3-D graphics library
3 *
4 * Copyright (C) 2012-2013 LunarG, Inc.
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 OR
17 * 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 OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 * DEALINGS IN THE SOFTWARE.
23 *
24 * Authors:
25 * Chia-I Wu <olv@lunarg.com>
26 */
27
28 #ifndef ILO_RESOURCE_H
29 #define ILO_RESOURCE_H
30
31 #include "core/intel_winsys.h"
32 #include "core/ilo_buffer.h"
33 #include "core/ilo_image.h"
34
35 #include "ilo_common.h"
36 #include "ilo_screen.h"
37
38 enum ilo_texture_flags {
39 /*
40 * Possible writers of a texture. There can be at most one writer at any
41 * time.
42 *
43 * Wine set in resolve flags (in ilo_blit_resolve_slices()), they indicate
44 * the new writer. When set in slice flags (ilo_texture_slice::flags),
45 * they indicate the writer since last resolve.
46 */
47 ILO_TEXTURE_RENDER_WRITE = 1 << 0,
48 ILO_TEXTURE_BLT_WRITE = 1 << 1,
49 ILO_TEXTURE_CPU_WRITE = 1 << 2,
50
51 /*
52 * Possible readers of a texture. There may be multiple readers at any
53 * time.
54 *
55 * When set in resolve flags, they indicate the new readers. They are
56 * never set in slice flags.
57 */
58 ILO_TEXTURE_RENDER_READ = 1 << 3,
59 ILO_TEXTURE_BLT_READ = 1 << 4,
60 ILO_TEXTURE_CPU_READ = 1 << 5,
61
62 /*
63 * Set when the texture is cleared.
64 *
65 * When set in resolve flags, the new writer will clear. When set in slice
66 * flags, the slice has been cleared to ilo_texture_slice::clear_value.
67 */
68 ILO_TEXTURE_CLEAR = 1 << 6,
69
70 /*
71 * Set when HiZ can be enabled.
72 *
73 * It is never set in resolve flags. When set in slice flags, the slice
74 * can have HiZ enabled. It is to be noted that this bit is always set for
75 * either all or none of the slices in a level, allowing quick check in
76 * case of layered rendering.
77 */
78 ILO_TEXTURE_HIZ = 1 << 7,
79 };
80
81 /**
82 * A 3D image slice, cube face, or array layer.
83 */
84 struct ilo_texture_slice {
85 unsigned flags;
86
87 /*
88 * Slice clear value. It is served for two purposes
89 *
90 * - the clear value used in commands such as 3DSTATE_CLEAR_PARAMS
91 * - the clear value when ILO_TEXTURE_CLEAR is set
92 *
93 * Since commands such as 3DSTATE_CLEAR_PARAMS expect a single clear value
94 * for all slices, ilo_blit_resolve_slices() will silently make all slices
95 * to have the same clear value.
96 */
97 uint32_t clear_value;
98 };
99
100 struct ilo_texture {
101 struct pipe_resource base;
102
103 bool imported;
104
105 struct ilo_image image;
106
107 /* XXX thread-safety */
108 struct ilo_texture_slice *slices[PIPE_MAX_TEXTURE_LEVELS];
109
110 struct ilo_texture *separate_s8;
111 };
112
113 struct ilo_buffer_resource {
114 struct pipe_resource base;
115
116 struct ilo_buffer buffer;
117 };
118
119 static inline struct ilo_buffer *
120 ilo_buffer(struct pipe_resource *res)
121 {
122 return (res && res->target == PIPE_BUFFER) ?
123 &((struct ilo_buffer_resource *) res)->buffer : NULL;
124 }
125
126 static inline struct ilo_texture *
127 ilo_texture(struct pipe_resource *res)
128 {
129 return (struct ilo_texture *)
130 ((res && res->target != PIPE_BUFFER) ? res : NULL);
131 }
132
133 void
134 ilo_init_resource_functions(struct ilo_screen *is);
135
136 bool
137 ilo_resource_rename_bo(struct pipe_resource *res);
138
139 /**
140 * Return the bo of the resource.
141 */
142 static inline struct intel_bo *
143 ilo_resource_get_bo(struct pipe_resource *res)
144 {
145 return (res->target == PIPE_BUFFER) ?
146 ilo_buffer(res)->bo : ilo_texture(res)->image.bo;
147 }
148
149 static inline struct ilo_texture_slice *
150 ilo_texture_get_slice(const struct ilo_texture *tex,
151 unsigned level, unsigned slice)
152 {
153 assert(level <= tex->base.last_level);
154 assert(slice < ((tex->base.target == PIPE_TEXTURE_3D) ?
155 u_minify(tex->base.depth0, level) : tex->base.array_size));
156
157 return &tex->slices[level][slice];
158 }
159
160 static inline void
161 ilo_texture_set_slice_flags(struct ilo_texture *tex, unsigned level,
162 unsigned first_slice, unsigned num_slices,
163 unsigned mask, unsigned value)
164 {
165 const struct ilo_texture_slice *last =
166 ilo_texture_get_slice(tex, level, first_slice + num_slices - 1);
167 struct ilo_texture_slice *slice =
168 ilo_texture_get_slice(tex, level, first_slice);
169
170 while (slice <= last) {
171 slice->flags = (slice->flags & ~mask) | (value & mask);
172 slice++;
173 }
174 }
175
176 static inline void
177 ilo_texture_set_slice_clear_value(struct ilo_texture *tex, unsigned level,
178 unsigned first_slice, unsigned num_slices,
179 uint32_t clear_value)
180 {
181 const struct ilo_texture_slice *last =
182 ilo_texture_get_slice(tex, level, first_slice + num_slices - 1);
183 struct ilo_texture_slice *slice =
184 ilo_texture_get_slice(tex, level, first_slice);
185
186 while (slice <= last) {
187 slice->clear_value = clear_value;
188 slice++;
189 }
190 }
191
192 static inline bool
193 ilo_texture_can_enable_hiz(const struct ilo_texture *tex, unsigned level,
194 unsigned first_slice, unsigned num_slices)
195 {
196 /*
197 * Either all or none of the slices in the same level have ILO_TEXTURE_HIZ
198 * set. It suffices to check only the first slice.
199 */
200 const struct ilo_texture_slice *slice =
201 ilo_texture_get_slice(tex, level, 0);
202
203 return (tex->image.aux_bo && (slice->flags & ILO_TEXTURE_HIZ));
204 }
205
206 #endif /* ILO_RESOURCE_H */