1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490
use Handle;
use gl;
use smallvec::SmallVec;
/// Represents the current OpenGL state.
///
/// The current state is passed to each function and can be freely updated.
pub struct GlState {
/// Whether we have detected that the context has been lost.
///
/// Even when this is `false`, the context may have been lost since the last query. So we have
/// to check for lost context as long as this is false.
pub lost_context: bool,
/// Whether GL_BLEND is enabled
pub enabled_blend: bool,
/// Whether GL_CULL_FACE is enabled
pub enabled_cull_face: bool,
/// Whether GL_DEBUG_OUTPUT is enabled. None means "unknown".
pub enabled_debug_output: Option<bool>,
/// Whether GL_DEBUG_OUTPUT_SYNCHRONOUS is enabled
pub enabled_debug_output_synchronous: bool,
/// Whether GL_DEPTH_TEST is enabled
pub enabled_depth_test: bool,
/// Whether DEPTH_CLAMP_NEAR is enabled.
pub enabled_depth_clamp_near: bool,
/// Whether DEPTH_CLAMP_FAR is enabled.
pub enabled_depth_clamp_far: bool,
/// Whether GL_DITHER is enabled
pub enabled_dither: bool,
/// Whether GL_FRAMEBUFFER_SRGB is enabled
pub enabled_framebuffer_srgb: bool,
/// Whether GL_MULTISAMPLE is enabled
pub enabled_multisample: bool,
/// Whether GL_POLYGON_OFFSET_FILL is enabled
pub enabled_polygon_offset_fill: bool,
/// Whether GL_PRIMITIVE_RESTART_FIXED_INDEX is enabled
pub enabled_primitive_fixed_restart: bool,
/// Whether GL_RASTERIZER_DISCARD is enabled
pub enabled_rasterizer_discard: bool,
/// Whether GL_SAMPLE_ALPHA_TO_COVERAGE is enabled
pub enabled_sample_alpha_to_coverage: bool,
/// Whether GL_SAMPLE_COVERAGE is enabled
pub enabled_sample_coverage: bool,
/// Whether GL_SCISSOR_TEST is enabled
pub enabled_scissor_test: bool,
/// Whether GL_STENCIL_TEST is enabled
pub enabled_stencil_test: bool,
/// Whether GL_LINE_SMOOTH is enabled
pub enabled_line_smooth: bool,
/// Whether GL_POLYGON_SMOOTH is enabled
pub enabled_polygon_smooth: bool,
/// Whether GL_PROGRAM_POINT_SIZE is enabled
pub enabled_program_point_size: bool,
/// The latest value passed to `glUseProgram`.
pub program: Handle,
/// The latest value passed to `glBindVertexArray`.
pub vertex_array: gl::types::GLuint,
/// The latest value passed to `glClearColor`.
pub clear_color: (gl::types::GLclampf, gl::types::GLclampf,
gl::types::GLclampf, gl::types::GLclampf),
/// The latest value passed to `glClearDepthf`.
pub clear_depth: gl::types::GLclampf,
/// The latest value passed to `glClearStencil`.
pub clear_stencil: gl::types::GLint,
/// The latest values passed to ``glColorMask`.
pub color_mask: (gl::types::GLboolean, gl::types::GLboolean,
gl::types::GLboolean, gl::types::GLboolean),
/// The latest buffer bound to `GL_ARRAY_BUFFER`.
pub array_buffer_binding: gl::types::GLuint,
/// The latest buffer bound to `GL_PIXEL_PACK_BUFFER`.
pub pixel_pack_buffer_binding: gl::types::GLuint,
/// The latest buffer bound to `GL_PIXEL_UNPACK_BUFFER`.
pub pixel_unpack_buffer_binding: gl::types::GLuint,
/// The latest buffer bound to `GL_UNIFORM_BUFFER`.
pub uniform_buffer_binding: gl::types::GLuint,
/// List of buffers bound to the indexed `GL_UNIFORM_BUFFER`.
pub indexed_uniform_buffer_bindings: SmallVec<[IndexedBufferState ; 8]>,
/// The latest buffer bound to `GL_COPY_READ_BUFFER`.
pub copy_read_buffer_binding: gl::types::GLuint,
/// The latest buffer bound to `GL_COPY_WRITE_BUFFER`.
pub copy_write_buffer_binding: gl::types::GLuint,
/// The latest buffer bound to `GL_DISPATCH_INDIRECT_BUFFER`.
pub dispatch_indirect_buffer_binding: gl::types::GLuint,
/// The latest buffer bound to `GL_DRAW_INDIRECT_BUFFER`.
pub draw_indirect_buffer_binding: gl::types::GLuint,
/// The latest buffer bound to `GL_QUERY_BUFFER`.
pub query_buffer_binding: gl::types::GLuint,
/// The latest buffer bound to `GL_TEXTURE_BUFFER`.
pub texture_buffer_binding: gl::types::GLuint,
/// The latest buffer bound to `GL_ATOMIC_COUNTER_BUFFER`.
pub atomic_counter_buffer_binding: gl::types::GLuint,
/// List of buffers bound to the indexed `GL_ATOMIC_COUNTER_BUFFER`.
pub indexed_atomic_counter_buffer_bindings: SmallVec<[IndexedBufferState ; 8]>,
/// The latest buffer bound to `GL_SHADER_STORAGE_BUFFER`.
pub shader_storage_buffer_binding: gl::types::GLuint,
/// List of buffers bound to the indexed `GL_SHADER_STORAGE_BUFFER`.
pub indexed_shader_storage_buffer_bindings: SmallVec<[IndexedBufferState ; 8]>,
/// List of buffers bound to the indexed `GL_TRANSFORM_FEEDBACK_BUFFER`.
pub indexed_transform_feedback_buffer_bindings: SmallVec<[IndexedBufferState; 4]>,
/// The latest buffer bound to `GL_READ_FRAMEBUFFER`.
pub read_framebuffer: gl::types::GLuint,
/// The latest buffer bound to `GL_DRAW_FRAMEBUFFER`.
pub draw_framebuffer: gl::types::GLuint,
/// The latest values passed to `glReadBuffer` with the default framebuffer.
/// `None` means "unknown".
pub default_framebuffer_read: Option<gl::types::GLenum>,
/// The latest render buffer bound with `glBindRenderbuffer`.
pub renderbuffer: gl::types::GLuint,
/// The latest values passed to `glBlendEquation`.
pub blend_equation: (gl::types::GLenum, gl::types::GLenum),
/// The latest values passed to `glBlendFunc`.
pub blend_func: (gl::types::GLenum, gl::types::GLenum,
gl::types::GLenum, gl::types::GLenum),
/// The latest value passed to `glBlendColor`.
pub blend_color: (gl::types::GLclampf, gl::types::GLclampf,
gl::types::GLclampf, gl::types::GLclampf),
/// The latest value passed to `glDepthFunc`.
pub depth_func: gl::types::GLenum,
/// The latest value passed to `glDepthMask`.
pub depth_mask: bool,
/// The latest values passed to `glDepthRange`.
pub depth_range: (f32, f32),
/// The latest values passed to `glStencilFuncSeparate` with face `GL_FRONT`.
pub stencil_func_front: (gl::types::GLenum, gl::types::GLint, gl::types::GLuint),
/// The latest values passed to `glStencilFuncSeparate` with face `GL_BACK`.
pub stencil_func_back: (gl::types::GLenum, gl::types::GLint, gl::types::GLuint),
/// The latest value passed to `glStencilMaskSeparate` with face `GL_FRONT`.
pub stencil_mask_front: gl::types::GLuint,
/// The latest value passed to `glStencilMaskSeparate` with face `GL_BACK`.
pub stencil_mask_back: gl::types::GLuint,
/// The latest values passed to `glStencilOpSeparate` with face `GL_FRONT`.
pub stencil_op_front: (gl::types::GLenum, gl::types::GLenum, gl::types::GLenum),
/// The latest values passed to `glStencilOpSeparate` with face `GL_BACK`.
pub stencil_op_back: (gl::types::GLenum, gl::types::GLenum, gl::types::GLenum),
/// The latest values passed to `glViewport`. `None` means unknown.
pub viewport: Option<(gl::types::GLint, gl::types::GLint,
gl::types::GLsizei, gl::types::GLsizei)>,
/// The latest values passed to `glScissor`. `None` means unknown.
pub scissor: Option<(gl::types::GLint, gl::types::GLint,
gl::types::GLsizei, gl::types::GLsizei)>,
/// The latest value passed to `glLineWidth`.
pub line_width: gl::types::GLfloat,
/// The latest value passed to `glPointSize`.
pub point_size: gl::types::GLfloat,
/// The latest value passed to `glCullFace`.
pub cull_face: gl::types::GLenum,
/// The latest value passed to `glPolygonMode`.
pub polygon_mode: gl::types::GLenum,
/// The latest value passed to `glHint` for smoothing.
pub smooth: (gl::types::GLenum, gl::types::GLenum),
/// The latest value passed to `glProvokingVertex`.
pub provoking_vertex: gl::types::GLenum,
/// The latest value passed to `glPixelStore` with `GL_UNPACK_ALIGNMENT`.
pub pixel_store_unpack_alignment: gl::types::GLint,
/// The latest value passed to `glPixelStore` with `GL_PACK_ALIGNMENT`.
pub pixel_store_pack_alignment: gl::types::GLint,
/// The latest value passed to `glClampColor`.
pub clamp_color: gl::types::GLenum,
/// The latest value passed to `glPatchParameter` with `GL_PATCH_VERTICES`.
pub patch_patch_vertices: gl::types::GLint,
/// The id of the active texture unit.
/// IMPORTANT: this is a raw number (0, 1, 2, ...), not an
/// enumeration (GL_TEXTURE0, GL_TEXTURE1, ...).
pub active_texture: gl::types::GLenum,
/// List of texture units.
pub texture_units: SmallVec<[TextureUnitState ; 32]>,
/// Current query being used for GL_SAMPLES_PASSED.
pub samples_passed_query: gl::types::GLuint,
/// Current query being used for GL_ANY_SAMPLES_PASSED.
pub any_samples_passed_query: gl::types::GLuint,
/// Current query being used for GL_ANY_SAMPLES_PASSED_CONSERVATIVE.
pub any_samples_passed_conservative_query: gl::types::GLuint,
/// Current query being used for GL_PRIMITIVES_GENERATED.
pub primitives_generated_query: gl::types::GLuint,
/// Current query being used for GL_TRANSFORM_FEEDBACK_PRIMITIVES_WRITTEN.
pub transform_feedback_primitives_written_query: gl::types::GLuint,
/// Current query being used for GL_TIME_ELAPSED.
pub time_elapsed_query: gl::types::GLuint,
/// Latest value passed to `glBeginConditionalRender`.
pub conditional_render: Option<(gl::types::GLuint, gl::types::GLenum)>,
/// If `glBeginTransformFeedback` has been called, the current primitive types. Otherwise None.
// TODO: move this inside transform feedback objects
pub transform_feedback_enabled: Option<gl::types::GLenum>,
/// True if `glPauseTransformFeedback` has been called.
// TODO: move this inside transform feedback objects
pub transform_feedback_paused: bool,
/// The latest value passed to `glPrimitiveBoundingBox`.
pub primitive_bounding_box: (f32, f32, f32, f32, f32, f32, f32, f32),
/// Current draw call ID.
/// We maintain a counter that is incremented at each draw call.
pub next_draw_call_id: u64,
/// The draw call ID of the latest call to `glMemoryBarrier` with
/// `GL_VERTEX_ATTRIB_ARRAY_BARRIER_BIT`.
pub latest_memory_barrier_vertex_attrib_array: u64,
/// The draw call ID of the latest call to `glMemoryBarrier` with
/// `GL_ELEMENT_ARRAY_BARRIER_BIT`.
pub latest_memory_barrier_element_array: u64,
/// The draw call ID of the latest call to `glMemoryBarrier` with
/// `GL_UNIFORM_BARRIER_BIT`.
pub latest_memory_barrier_uniform: u64,
/// The draw call ID of the latest call to `glMemoryBarrier` with
/// `GL_TEXTURE_FETCH_BARRIER_BIT`.
pub latest_memory_barrier_texture_fetch: u64,
/// The draw call ID of the latest call to `glMemoryBarrier` with
/// `GL_SHADER_IMAGE_ACCESS_BARRIER_BIT`.
pub latest_memory_barrier_shader_image_access: u64,
/// The draw call ID of the latest call to `glMemoryBarrier` with
/// `GL_COMMAND_BARRIER_BIT`.
pub latest_memory_barrier_command: u64,
/// The draw call ID of the latest call to `glMemoryBarrier` with
/// `GL_PIXEL_BUFFER_BARRIER_BIT`.
pub latest_memory_barrier_pixel_buffer: u64,
/// The draw call ID of the latest call to `glMemoryBarrier` with
/// `GL_TEXTURE_UPDATE_BARRIER_BIT`.
pub latest_memory_barrier_texture_update: u64,
/// The draw call ID of the latest call to `glMemoryBarrier` with
/// `GL_BUFFER_UPDATE_BARRIER_BIT`.
pub latest_memory_barrier_buffer_update: u64,
/// The draw call ID of the latest call to `glMemoryBarrier` with
/// `GL_FRAMEBUFFER_BARRIER_BIT`.
pub latest_memory_barrier_framebuffer: u64,
/// The draw call ID of the latest call to `glMemoryBarrier` with
/// `GL_TRANSFORM_FEEDBACK_BARRIER_BIT`.
pub latest_memory_barrier_transform_feedback: u64,
/// The draw call ID of the latest call to `glMemoryBarrier` with
/// `GL_ATOMIC_COUNTER_BARRIER_BIT`.
pub latest_memory_barrier_atomic_counter: u64,
/// The draw call ID of the latest call to `glMemoryBarrier` with
/// `GL_SHADER_STORAGE_BARRIER_BIT`.
pub latest_memory_barrier_shader_storage: u64,
/// The draw call ID of the latest call to `glMemoryBarrier` with
/// `GL_QUERY_BUFFER_BARRIER_BIT`.
pub latest_memory_barrier_query_buffer: u64,
}
/// State of a texture unit (the one designated by `glActiveTexture`).
#[derive(Copy, Clone, Debug)]
pub struct TextureUnitState {
/// Id of the texture.
pub texture: gl::types::GLuint,
/// Id of the sampler.
pub sampler: gl::types::GLuint,
}
/// State of an indexed buffer target (`glBindBufferRange`/`glBindBufferBase`).
#[derive(Copy, Clone, Debug)]
pub struct IndexedBufferState {
/// Id of the buffer.
pub buffer: gl::types::GLuint,
/// Starting offset in bytes.
pub offset: gl::types::GLintptr,
/// Size in bytes.
pub size: gl::types::GLsizeiptr,
}
/// Builds the `GlState` corresponding to a newly-created OpenGL context.
impl Default for GlState {
fn default() -> GlState {
fn small_vec_one<T>() -> SmallVec<T> where T: ::smallvec::Array, T::Item: Default {
let mut v = SmallVec::new();
v.push(Default::default());
v
}
GlState {
lost_context: false,
enabled_blend: false,
enabled_cull_face: false,
enabled_debug_output: None,
enabled_debug_output_synchronous: false,
enabled_depth_test: false,
enabled_depth_clamp_near: false,
enabled_depth_clamp_far: false,
enabled_dither: false,
enabled_framebuffer_srgb: false,
enabled_multisample: true,
enabled_polygon_offset_fill: false,
enabled_rasterizer_discard: false,
enabled_sample_alpha_to_coverage: false,
enabled_sample_coverage: false,
enabled_scissor_test: false,
enabled_stencil_test: false,
enabled_line_smooth: false,
enabled_polygon_smooth: false,
enabled_primitive_fixed_restart: false,
enabled_program_point_size: false,
program: Handle::Id(0),
vertex_array: 0,
clear_color: (0.0, 0.0, 0.0, 0.0),
clear_depth: 1.0,
clear_stencil: 0,
color_mask: (1, 1, 1, 1),
array_buffer_binding: 0,
pixel_pack_buffer_binding: 0,
pixel_unpack_buffer_binding: 0,
uniform_buffer_binding: 0,
indexed_uniform_buffer_bindings: small_vec_one(),
copy_read_buffer_binding: 0,
copy_write_buffer_binding: 0,
dispatch_indirect_buffer_binding: 0,
draw_indirect_buffer_binding: 0,
query_buffer_binding: 0,
texture_buffer_binding: 0,
atomic_counter_buffer_binding: 0,
indexed_atomic_counter_buffer_bindings: small_vec_one(),
shader_storage_buffer_binding: 0,
indexed_shader_storage_buffer_bindings: small_vec_one(),
indexed_transform_feedback_buffer_bindings: small_vec_one(),
read_framebuffer: 0,
draw_framebuffer: 0,
default_framebuffer_read: None,
renderbuffer: 0,
depth_func: gl::LESS,
depth_mask: true,
depth_range: (0.0, 1.0),
stencil_func_front: (gl::ALWAYS, 0, 0xffffffff),
stencil_func_back: (gl::ALWAYS, 0, 0xffffffff),
stencil_mask_front: 0xffffffff,
stencil_mask_back: 0xffffffff,
stencil_op_front: (gl::KEEP, gl::KEEP, gl::KEEP),
stencil_op_back: (gl::KEEP, gl::KEEP, gl::KEEP),
blend_equation: (gl::FUNC_ADD, gl::FUNC_ADD),
blend_func: (gl::ONE, gl::ZERO, gl::ONE, gl::ZERO),
blend_color: (0.0, 0.0, 0.0, 0.0),
viewport: None,
scissor: None,
line_width: 1.0,
point_size: 1.0,
cull_face: gl::BACK,
polygon_mode: gl::FILL,
smooth: (gl::DONT_CARE, gl::DONT_CARE),
provoking_vertex: gl::LAST_VERTEX_CONVENTION,
pixel_store_unpack_alignment: 4,
pixel_store_pack_alignment: 4,
clamp_color: gl::FIXED_ONLY,
patch_patch_vertices: 3,
active_texture: 0,
texture_units: small_vec_one(),
samples_passed_query: 0,
any_samples_passed_query: 0,
any_samples_passed_conservative_query: 0,
primitives_generated_query: 0,
transform_feedback_primitives_written_query: 0,
time_elapsed_query: 0,
conditional_render: None,
transform_feedback_enabled: None,
transform_feedback_paused: false,
primitive_bounding_box: (-1.0, -1.0, -1.0, -1.0, 1.0, 1.0, 1.0, 1.0),
next_draw_call_id: 1,
latest_memory_barrier_vertex_attrib_array: 1,
latest_memory_barrier_element_array: 1,
latest_memory_barrier_uniform: 1,
latest_memory_barrier_texture_fetch: 1,
latest_memory_barrier_shader_image_access: 1,
latest_memory_barrier_command: 1,
latest_memory_barrier_pixel_buffer: 1,
latest_memory_barrier_texture_update: 1,
latest_memory_barrier_buffer_update: 1,
latest_memory_barrier_framebuffer: 1,
latest_memory_barrier_transform_feedback: 1,
latest_memory_barrier_atomic_counter: 1,
latest_memory_barrier_shader_storage: 1,
latest_memory_barrier_query_buffer: 1,
}
}
}
impl Default for TextureUnitState {
#[inline]
fn default() -> TextureUnitState {
TextureUnitState {
texture: 0,
sampler: 0,
}
}
}
impl Default for IndexedBufferState {
#[inline]
fn default() -> IndexedBufferState {
IndexedBufferState {
buffer: 0,
offset: 0,
size: 0,
}
}
}