1 /**************************************************************************
3 * Copyright 2007-2008 VMware, Inc.
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:
14 * The above copyright notice and this permission notice (including the
15 * next paragraph) shall be included in all copies or substantial portions
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 VMWARE 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.
26 **************************************************************************/
30 * Constant State Object (CSO) cache.
32 * The basic idea is that the states are created via the
33 * create_state/bind_state/delete_state semantics. The driver is expected to
34 * perform as much of the Gallium state translation to whatever its internal
35 * representation is during the create call. Gallium then has a caching
36 * mechanism where it stores the created states. When the pipeline needs an
37 * actual state change, a bind call is issued. In the bind call the driver
38 * gets its already translated representation.
40 * Those semantics mean that the driver doesn't do the repeated translations
41 * of states on every frame, but only once, when a new state is actually
44 * Even on hardware that doesn't do any kind of state cache, it makes the
45 * driver look a lot neater, plus it avoids all the redundant state
46 * translations on every frame.
48 * Currently our constant state objects are:
53 * - rasterizer (old setup)
58 * Things that are not constant state objects include:
70 * @author Zack Rusin <zackr@vmware.com>
76 #include "pipe/p_context.h"
77 #include "pipe/p_state.h"
79 /* cso_hash.h is necessary for cso_hash_iter, as MSVC requires structures
80 * returned by value to be fully defined */
91 CSO_DEPTH_STENCIL_ALPHA
,
97 typedef void (*cso_state_callback
)(void *ctx
, void *obj
);
99 typedef void (*cso_sanitize_callback
)(struct cso_hash
*hash
,
100 enum cso_cache_type type
,
107 struct pipe_blend_state state
;
109 cso_state_callback delete_state
;
110 struct pipe_context
*context
;
113 struct cso_depth_stencil_alpha
{
114 struct pipe_depth_stencil_alpha_state state
;
116 cso_state_callback delete_state
;
117 struct pipe_context
*context
;
120 struct cso_rasterizer
{
121 struct pipe_rasterizer_state state
;
123 cso_state_callback delete_state
;
124 struct pipe_context
*context
;
128 struct pipe_sampler_state state
;
130 cso_state_callback delete_state
;
131 struct pipe_context
*context
;
135 struct cso_velems_state
{
137 struct pipe_vertex_element velems
[PIPE_MAX_ATTRIBS
];
140 struct cso_velements
{
141 struct cso_velems_state state
;
143 cso_state_callback delete_state
;
144 struct pipe_context
*context
;
147 unsigned cso_construct_key(void *item
, int item_size
);
149 struct cso_cache
*cso_cache_create(void);
150 void cso_cache_delete(struct cso_cache
*sc
);
152 void cso_cache_set_sanitize_callback(struct cso_cache
*sc
,
153 cso_sanitize_callback cb
,
156 struct cso_hash_iter
cso_insert_state(struct cso_cache
*sc
,
157 unsigned hash_key
, enum cso_cache_type type
,
159 struct cso_hash_iter
cso_find_state(struct cso_cache
*sc
,
160 unsigned hash_key
, enum cso_cache_type type
);
161 struct cso_hash_iter
cso_find_state_template(struct cso_cache
*sc
,
162 unsigned hash_key
, enum cso_cache_type type
,
163 void *templ
, unsigned size
);
164 void cso_for_each_state(struct cso_cache
*sc
, enum cso_cache_type type
,
165 cso_state_callback func
, void *user_data
);
166 void * cso_take_state(struct cso_cache
*sc
, unsigned hash_key
,
167 enum cso_cache_type type
);
169 void cso_set_maximum_cache_size(struct cso_cache
*sc
, int number
);
170 int cso_maximum_cache_size(const struct cso_cache
*sc
);