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 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513
/*!
Contains everything related to the internal handling of framebuffer objects.
*/
/*
Here are the rules taken from the official wiki:
Attachment Completeness
Each attachment point itctxt.framebuffer_objects must be complete according to these rules. Empty attachments
(attachments with no image attached) are complete by default. If an image is attached, it must
adhere to the following rules:
The source object for the image still exists and has the same type it was attached with.
The image has a non-zero width and height (the height of a 1D image is assumed to be 1). The
width/height must also be less than GL_MAX_FRAMEBUFFER_WIDTH and GL_MAX_FRAMEBUFFER_HEIGHT
respectively (if GL 4.3/ARB_framebuffer_no_attachments).
The layer for 3D or array textures attachments is less than the depth of the texture. It must
also be less than GL_MAX_FRAMEBUFFER_LAYERS (if GL 4.3/ARB_framebuffer_no_attachments).
The number of samples must be less than GL_MAX_FRAMEBUFFER_SAMPLES (if
GL 4.3/ARB_framebuffer_no_attachments).
The image's format must match the attachment point's requirements, as defined above.
Color-renderable formats for color attachments, etc.
Completeness Rules
These are the rules for framebuffer completeness. The order of these rules matters.
If the target of glCheckFramebufferStatus references the Default Framebuffer (ie: FBO object
number 0 is bound), and the default framebuffer does not exist, then you will get
GL_FRAMEBUFFER_UNDEFINEZ. If the default framebuffer exists, then you always get
GL_FRAMEBUFFER_COMPLETE. The rest of the rules apply when an FBO is bound.
All attachments must be attachment complete. (GL_FRAMEBUFFER_INCOMPLETE_ATTACHMENT when false).
There must be at least one image attached to the FBO, or if OpenGL 4.3 or
ARB_framebuffer_no_attachment is available, the GL_FRAMEBUFFER_DEFAULT_WIDTH and
GL_FRAMEBUFFER_DEFAULT_HEIGHT parameters of the framebuffer must both be non-zero.
(GL_FRAMEBUFFER_INCOMPLETE_MISSING_ATTACHMENT when false).
Each draw buffers must either specify color attachment points that have images attached or
must be GL_NONE. (GL_FRAMEBUFFER_INCOMPLETE_DRAW_BUFFER when false). Note that this test is
not performed if OpenGL 4.1 or ARB_ES2_compatibility is available.
If the read buffer is set, then it must specify an attachment point that has an image
attached. (GL_FRAMEBUFFER_INCOMPLETE_READ_BUFFER when false). Note that this test is not
performed if OpenGL 4.1 or ARB_ES2_compatibility is available.
All images must have the same number of multisample samples.
(GL_FRAMEBUFFER_INCOMPLETE_MULTISAMPLE when false).
If a layered image is attached to one attachment, then all attachments must be layered
attachments. The attached layers do not have to have the same number of layers, nor do the
layers have to come from the same kind of texture (a cubemap color texture can be paired
with an array depth texture) (GL_FRAMEBUFFER_INCOMPLETE_LAYER_TARGETS when false).
*/
use std::{ cmp, mem, fmt };
use std::error::Error;
use std::cell::RefCell;
use std::marker::PhantomData;
use std::hash::BuildHasherDefault;
use std::collections::HashMap;
use fnv::FnvHasher;
use smallvec::SmallVec;
use CapabilitiesSource;
use GlObject;
use TextureExt;
use texture::CubeLayer;
use texture::TextureAnyImage;
use texture::TextureAnyMipmap;
use texture::TextureKind;
use framebuffer::RenderBufferAny;
use gl;
use context::CommandContext;
use version::Version;
use version::Api;
/// Returns true if the backend supports attachments with varying dimensions.
///
/// If this function returns `true` and you pass attachments with different dimensions, the
/// intersection between all the attachments will be used. If this function returns `false`, you'll
/// get an error instead.
pub fn is_dimensions_mismatch_supported<C: ?Sized>(context: &C) -> bool where C: CapabilitiesSource {
context.get_version() >= &Version(Api::Gl, 3, 0) ||
context.get_version() >= &Version(Api::GlEs, 2, 0) ||
context.get_extensions().gl_arb_framebuffer_object
}
/// Represents the attachments to use for an OpenGL framebuffer.
#[derive(Clone)]
pub enum FramebufferAttachments<'a> {
/// Each attachment is a single image.
Regular(FramebufferSpecificAttachments<RegularAttachment<'a>>),
/// Each attachment is a layer of images.
Layered(FramebufferSpecificAttachments<LayeredAttachment<'a>>),
/// An empty framebuffer.
Empty {
width: u32,
height: u32,
layers: Option<u32>,
samples: Option<u32>,
fixed_samples: bool,
},
}
/// Describes a single non-layered framebuffer attachment.
#[derive(Copy, Clone)]
pub enum RegularAttachment<'a> {
/// A texture.
Texture(TextureAnyImage<'a>),
/// A renderbuffer.
RenderBuffer(&'a RenderBufferAny),
}
impl<'a> RegularAttachment<'a> {
/// Returns the kind of attachment (float, integral, unsigned, depth, stencil, depthstencil).
#[inline]
pub fn kind(&self) -> TextureKind {
match self {
&RegularAttachment::Texture(t) => t.get_texture().kind(),
&RegularAttachment::RenderBuffer(rb) => rb.kind(),
}
}
}
/// Describes a single layered framebuffer attachment.
#[derive(Copy, Clone)]
pub struct LayeredAttachment<'a>(TextureAnyMipmap<'a>);
/// Depth and/or stencil attachment to use.
#[derive(Copy, Clone)]
pub enum DepthStencilAttachments<T> {
/// No depth or stencil buffer.
None,
/// A depth attachment.
DepthAttachment(T),
/// A stencil attachment.
StencilAttachment(T),
/// A depth attachment and a stencil attachment.
DepthAndStencilAttachments(T, T),
/// A single attachment that serves as both depth and stencil buffer.
DepthStencilAttachment(T),
}
/// Represents the attachments to use for an OpenGL framebuffer.
#[derive(Clone)]
pub struct FramebufferSpecificAttachments<T> {
/// List of color attachments. The first parameter of the tuple is the index, and the
/// second element is the attachment.
pub colors: SmallVec<[(u32, T); 5]>,
/// The depth and/or stencil attachment to use.
pub depth_stencil: DepthStencilAttachments<T>,
}
impl<'a> FramebufferAttachments<'a> {
/// After building a `FramebufferAttachments` struct, you must use this function
/// to "compile" the attachments and make sure that they are valid together.
#[inline]
pub fn validate<C: ?Sized>(self, context: &C) -> Result<ValidatedAttachments<'a>, ValidationError>
where C: CapabilitiesSource
{
match self {
FramebufferAttachments::Regular(a) => FramebufferAttachments::validate_regular(context, a),
FramebufferAttachments::Layered(a) => FramebufferAttachments::validate_layered(context, a),
FramebufferAttachments::Empty { width, height, layers, samples, fixed_samples } => {
if context.get_version() >= &Version(Api::Gl, 4, 3) ||
context.get_version() >= &Version(Api::GlEs, 3, 1) ||
context.get_extensions().gl_arb_framebuffer_no_attachments
{
assert!(width >= 1);
assert!(height >= 1);
if let Some(layers) = layers { assert!(layers >= 1); }
if let Some(samples) = samples { assert!(samples >= 1); }
if width > context.get_capabilities().max_framebuffer_width.unwrap_or(0) as u32 ||
height > context.get_capabilities().max_framebuffer_height.unwrap_or(0) as u32 ||
samples.unwrap_or(0) > context.get_capabilities()
.max_framebuffer_samples.unwrap_or(0) as u32 ||
layers.unwrap_or(0) > context.get_capabilities()
.max_framebuffer_layers.unwrap_or(0) as u32
{
return Err(ValidationError::EmptyFramebufferUnsupportedDimensions);
}
Ok(ValidatedAttachments {
raw: RawAttachments {
color: Vec::new(),
depth: None,
stencil: None,
depth_stencil: None,
default_width: Some(width),
default_height: Some(height),
default_layers: if context.get_version() <= &Version(Api::GlEs, 3, 1) { None } else { Some(layers.unwrap_or(0)) },
default_samples: Some(samples.unwrap_or(0)),
default_samples_fixed: Some(fixed_samples),
},
dimensions: (width, height),
layers: layers,
depth_buffer_bits: None,
stencil_buffer_bits: None,
marker: PhantomData,
})
} else {
Err(ValidationError::EmptyFramebufferObjectsNotSupported)
}
},
}
}
fn validate_layered<C: ?Sized>(context: &C, FramebufferSpecificAttachments { colors, depth_stencil }:
FramebufferSpecificAttachments<LayeredAttachment<'a>>)
-> Result<ValidatedAttachments<'a>, ValidationError>
where C: CapabilitiesSource
{
// TODO: make sure that all attachments are layered
macro_rules! handle_tex {
($tex:ident, $dim:ident, $samples:ident, $num_bits:ident) => ({
$num_bits = Some($tex.get_texture().get_internal_format()
.map(|f| f.get_total_bits()).ok().unwrap_or(24) as u16); // TODO: how to handle this?
handle_tex!($tex, $dim, $samples)
});
($tex:ident, $dim:ident, $samples:ident) => ({
// TODO: check that internal format is renderable
let context = $tex.get_texture().get_context();
match &mut $samples {
&mut Some(samples) => {
if samples != $tex.get_samples().unwrap_or(0) {
return Err(ValidationError::SamplesCountMismatch);
}
},
s @ &mut None => {
*s = Some($tex.get_samples().unwrap_or(0));
}
}
match &mut $dim {
&mut Some((ref mut w, ref mut h)) => {
let height = $tex.get_height().unwrap_or(1);
if *w != $tex.get_width() || *h != height {
*w = cmp::min(*w, $tex.get_width());
*h = cmp::min(*h, height);
// checking that multiple different sizes is supported by the backend
if !is_dimensions_mismatch_supported(context) {
return Err(ValidationError::DimensionsMismatchNotSupported);
}
}
},
dim @ &mut None => {
*dim = Some(($tex.get_width(), $tex.get_height().unwrap_or(1)));
},
}
RawAttachment::Texture {
texture: $tex.get_texture().get_id(),
bind_point: $tex.get_texture().get_bind_point(),
layer: None,
level: $tex.get_level(),
cubemap_layer: None,
}
});
}
let max_color_attachments = context.get_capabilities().max_color_attachments;
if colors.len() > max_color_attachments as usize {
return Err(ValidationError::TooManyColorAttachments{
maximum: max_color_attachments as usize,
obtained: colors.len(),
});
}
let mut raw_attachments = RawAttachments {
color: Vec::with_capacity(colors.len()),
depth: None,
stencil: None,
depth_stencil: None,
default_width: None,
default_height: None,
default_layers: None,
default_samples: None,
default_samples_fixed: None,
};
let mut dimensions = None;
let mut depth_bits = None;
let mut stencil_bits = None;
let mut samples = None; // contains `0` if not multisampling and `None` if unknown
for &(index, LayeredAttachment(ref attachment)) in colors.iter() {
if index >= max_color_attachments as u32 {
return Err(ValidationError::TooManyColorAttachments{
maximum: max_color_attachments as usize,
obtained: index as usize,
});
}
raw_attachments.color.push((index, handle_tex!(attachment, dimensions, samples)));
}
match depth_stencil {
DepthStencilAttachments::None => (),
DepthStencilAttachments::DepthAttachment(LayeredAttachment(ref d)) => {
raw_attachments.depth = Some(handle_tex!(d, dimensions, samples, depth_bits));
},
DepthStencilAttachments::StencilAttachment(LayeredAttachment(ref s)) => {
raw_attachments.stencil = Some(handle_tex!(s, dimensions, samples, stencil_bits));
},
DepthStencilAttachments::DepthAndStencilAttachments(LayeredAttachment(ref d),
LayeredAttachment(ref s))
=> {
raw_attachments.depth = Some(handle_tex!(d, dimensions, samples, depth_bits));
raw_attachments.stencil = Some(handle_tex!(s, dimensions, samples, stencil_bits));
},
DepthStencilAttachments::DepthStencilAttachment(LayeredAttachment(ref ds)) => {
// FIXME: bits count
raw_attachments.depth_stencil = Some(handle_tex!(ds, dimensions, samples));
},
}
let dimensions = if let Some(dimensions) = dimensions {
dimensions
} else {
// TODO: handle this
return Err(ValidationError::EmptyFramebufferObjectsNotSupported);
};
Ok(ValidatedAttachments {
raw: raw_attachments,
dimensions: dimensions,
layers: None, // FIXME: count layers
depth_buffer_bits: depth_bits,
stencil_buffer_bits: stencil_bits,
marker: PhantomData,
})
}
fn validate_regular<C: ?Sized>(context: &C, FramebufferSpecificAttachments { colors, depth_stencil }:
FramebufferSpecificAttachments<RegularAttachment<'a>>)
-> Result<ValidatedAttachments<'a>, ValidationError>
where C: CapabilitiesSource
{
macro_rules! handle_tex {
($tex:ident, $dim:ident, $samples:ident, $num_bits:ident) => ({
$num_bits = Some($tex.get_texture().get_internal_format()
.map(|f| f.get_total_bits()).ok().unwrap_or(24) as u16); // TODO: how to handle this?
handle_tex!($tex, $dim, $samples)
});
($tex:ident, $dim:ident, $samples:ident) => ({
// TODO: check that internal format is renderable
let context = $tex.get_texture().get_context();
match &mut $samples {
&mut Some(samples) => {
if samples != $tex.get_samples().unwrap_or(0) {
return Err(ValidationError::SamplesCountMismatch);
}
},
s @ &mut None => {
*s = Some($tex.get_samples().unwrap_or(0));
}
}
match &mut $dim {
&mut Some((ref mut w, ref mut h)) => {
let height = $tex.get_height().unwrap_or(1);
if *w != $tex.get_width() || *h != height {
*w = cmp::min(*w, $tex.get_width());
*h = cmp::min(*h, height);
// checking that multiple different sizes is supported by the backend
if !is_dimensions_mismatch_supported(context) {
return Err(ValidationError::DimensionsMismatchNotSupported);
}
}
},
dim @ &mut None => {
*dim = Some(($tex.get_width(), $tex.get_height().unwrap_or(1)));
},
}
RawAttachment::Texture {
texture: $tex.get_texture().get_id(),
bind_point: $tex.get_texture().get_bind_point(),
layer: Some($tex.get_layer()),
level: $tex.get_level(),
cubemap_layer: $tex.get_cubemap_layer(),
}
});
}
macro_rules! handle_rb {
($rb:ident, $dim:ident, $samples:ident, $num_bits:ident) => ({
$num_bits = Some(24); // FIXME: totally arbitrary
handle_rb!($rb, $dim, $samples)
});
($rb:ident, $dim:ident, $samples:ident) => ({
// TODO: check that internal format is renderable
let context = $rb.get_context();
let dimensions = $rb.get_dimensions();
match &mut $samples {
&mut Some(samples) => {
if samples != $rb.get_samples().unwrap_or(0) {
return Err(ValidationError::SamplesCountMismatch);
}
},
s @ &mut None => {
*s = Some($rb.get_samples().unwrap_or(0));
}
}
match &mut $dim {
&mut Some((ref mut w, ref mut h)) => {
if *w != dimensions.0 || *h != dimensions.1 {
*w = cmp::min(*w, dimensions.0);
*h = cmp::min(*h, dimensions.1);
// checking that multiple different sizes is supported by the backend
if !is_dimensions_mismatch_supported(context) {
return Err(ValidationError::DimensionsMismatchNotSupported);
}
}
},
dim @ &mut None => {
*dim = Some((dimensions.0, dimensions.1));
},
}
RawAttachment::RenderBuffer($rb.get_id())
});
}
macro_rules! handle_atch {
($atch:ident, $($t:tt)*) => (
match $atch {
&RegularAttachment::Texture(ref tex) => handle_tex!(tex, $($t)*),
&RegularAttachment::RenderBuffer(ref rb) => handle_rb!(rb, $($t)*),
}
);
}
let max_color_attachments = context.get_capabilities().max_color_attachments;
if colors.len() > max_color_attachments as usize {
return Err(ValidationError::TooManyColorAttachments{
maximum: max_color_attachments as usize,
obtained: colors.len(),
});
}
let mut raw_attachments = RawAttachments {
color: Vec::with_capacity(colors.len()),
depth: None,
stencil: None,
depth_stencil: None,
default_width: None,
default_height: None,
default_layers: None,
default_samples: None,
default_samples_fixed: None,
};
let mut dimensions = None;
let mut depth_bits = None;
let mut stencil_bits = None;
let mut samples = None; // contains `0` if not multisampling and `None` if unknown
for &(index, ref attachment) in colors.iter() {
if index >= max_color_attachments as u32 {
return Err(ValidationError::TooManyColorAttachments{
maximum: max_color_attachments as usize,
obtained: index as usize,
});
}
raw_attachments.color.push((index, handle_atch!(attachment, dimensions, samples)));
}
match depth_stencil {
DepthStencilAttachments::None => (),
DepthStencilAttachments::DepthAttachment(ref d) => {
raw_attachments.depth = Some(handle_atch!(d, dimensions, samples, depth_bits));
},
DepthStencilAttachments::StencilAttachment(ref s) => {
raw_attachments.stencil = Some(handle_atch!(s, dimensions, samples, stencil_bits));
},
DepthStencilAttachments::DepthAndStencilAttachments(ref d, ref s) => {
raw_attachments.depth = Some(handle_atch!(d, dimensions, samples, depth_bits));
raw_attachments.stencil = Some(handle_atch!(s, dimensions, samples, stencil_bits));
},
DepthStencilAttachments::DepthStencilAttachment(ref ds) => {
// FIXME: bits count
raw_attachments.depth_stencil = Some(handle_atch!(ds, dimensions, samples));
},
}
let dimensions = if let Some(dimensions) = dimensions {
dimensions
} else {
// TODO: handle this
return Err(ValidationError::EmptyFramebufferObjectsNotSupported);
};
Ok(ValidatedAttachments {
raw: raw_attachments,
dimensions: dimensions,
layers: None,
depth_buffer_bits: depth_bits,
stencil_buffer_bits: stencil_bits,
marker: PhantomData,
})
}
}
/// Represents attachments that have been validated and are usable.
#[derive(Clone)]
pub struct ValidatedAttachments<'a> {
raw: RawAttachments,
dimensions: (u32, u32),
layers: Option<u32>,
depth_buffer_bits: Option<u16>,
stencil_buffer_bits: Option<u16>,
marker: PhantomData<&'a ()>,
}
impl<'a> ValidatedAttachments<'a> {
/// Returns `true` if the framebuffer is layered.
#[inline]
pub fn is_layered(&self) -> bool {
self.layers.is_some()
}
/// Returns the dimensions that the framebuffer will have if you use these attachments.
#[inline]
pub fn get_dimensions(&self) -> (u32, u32) {
self.dimensions
}
/// Returns the number of bits of precision of the depth buffer, or `None` if there is no
/// depth buffer. Also works for depth-stencil buffers.
#[inline]
pub fn get_depth_buffer_bits(&self) -> Option<u16> {
self.depth_buffer_bits
}
/// Returns the number of bits of precision of the stencil buffer, or `None` if there is no
/// stencil buffer. Also works for depth-stencil buffers.
#[inline]
pub fn get_stencil_buffer_bits(&self) -> Option<u16> {
self.stencil_buffer_bits
}
}
/// An error that can happen while validating attachments.
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
pub enum ValidationError {
/// You requested an empty framebuffer object, but they are not supported.
EmptyFramebufferObjectsNotSupported,
/// The requested characteristics of an empty framebuffer object are out of range.
EmptyFramebufferUnsupportedDimensions,
/// The backend doesn't support attachments with various dimensions.
///
/// Note that almost all OpenGL implementations support attachments with various dimensions.
/// Only very old versions don't.
DimensionsMismatchNotSupported,
/// All attachments must have the same number of samples.
SamplesCountMismatch,
/// Backends only support a certain number of color attachments.
TooManyColorAttachments {
/// Maximum number of attachments.
maximum: usize,
/// Number of attachments that were given.
obtained: usize,
},
}
impl fmt::Display for ValidationError {
fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
use self::ValidationError::*;
match *self {
TooManyColorAttachments{ ref maximum, ref obtained } =>
write!(fmt, "{}: found {}, maximum: {}", self.description(), obtained, maximum),
_ =>
write!(fmt, "{}", self.description()),
}
}
}
impl Error for ValidationError {
fn description(&self) -> &str {
use self::ValidationError::*;
match *self {
EmptyFramebufferObjectsNotSupported =>
"You requested an empty framebuffer object, but they are not supported",
EmptyFramebufferUnsupportedDimensions =>
"The requested characteristics of an empty framebuffer object are out of range",
DimensionsMismatchNotSupported =>
"The backend doesn't support attachments with various dimensions",
SamplesCountMismatch =>
"All attachments must have the same number of samples",
TooManyColorAttachments {..} =>
"Backends only support a certain number of color attachments",
}
}
}
/// Data structure stored in the hashmap.
///
/// These attachments are guaranteed to be valid.
#[derive(Hash, Clone, Eq, PartialEq)]
struct RawAttachments {
// for each frag output the location, the attachment to use
color: Vec<(u32, RawAttachment)>,
depth: Option<RawAttachment>,
stencil: Option<RawAttachment>,
depth_stencil: Option<RawAttachment>,
// values to set through `glFramebufferParameteri`, they are `None` if they should not be set
default_width: Option<u32>,
default_height: Option<u32>,
default_layers: Option<u32>,
default_samples: Option<u32>,
default_samples_fixed: Option<bool>,
}
/// Single attachment of `RawAttachments`.
#[derive(Hash, Copy, Clone, Eq, PartialEq)]
enum RawAttachment {
/// A texture.
Texture {
// a GLenum like `TEXTURE_2D`, `TEXTURE_3D`, etc.
bind_point: gl::types::GLenum, // TODO: Dimensions instead
// id of the texture
texture: gl::types::GLuint,
// if `Some`, use a regular attachment ; if `None`, use a layered attachment
// if `None`, the texture **must** be an array, cubemap, or texture 3d
layer: Option<u32>,
// mipmap level
level: u32,
// layer of the cubemap, if this is a cubemap
cubemap_layer: Option<CubeLayer>,
},
/// A renderbuffer with its ID.
RenderBuffer(gl::types::GLuint),
}
/// Data to pass to the `clear_buffer` function.
#[derive(Debug, Copy, Clone)]
pub enum ClearBufferData {
/// Suitable for float attachments.
Float([f32; 4]),
/// Suitable for integral textures.
Integral([i32; 4]),
/// Suitable for unsigned textures.
Unsigned([u32; 4]),
/// Suitable for depth attachments.
Depth(f32),
/// Suitable for stencil attachments.
Stencil(i32),
/// Suitable for depth-stencil attachments.
DepthStencil(f32, i32),
}
impl From<[f32; 4]> for ClearBufferData {
#[inline]
fn from(data: [f32; 4]) -> ClearBufferData {
ClearBufferData::Float(data)
}
}
impl From<[i32; 4]> for ClearBufferData {
#[inline]
fn from(data: [i32; 4]) -> ClearBufferData {
ClearBufferData::Integral(data)
}
}
impl From<[u32; 4]> for ClearBufferData {
#[inline]
fn from(data: [u32; 4]) -> ClearBufferData {
ClearBufferData::Unsigned(data)
}
}
/// Manages all the framebuffer objects.
///
/// `cleanup` **must** be called when destroying the container, otherwise `Drop` will panic.
pub struct FramebuffersContainer {
framebuffers: RefCell<HashMap<RawAttachments, FrameBufferObject, BuildHasherDefault<FnvHasher>>>,
}
impl FramebuffersContainer {
/// Initializes the container.
#[inline]
pub fn new() -> FramebuffersContainer {
FramebuffersContainer {
framebuffers: RefCell::new(HashMap::with_hasher(Default::default())),
}
}
/// Destroys all framebuffer objects. This is used when using a new context for example.
pub fn purge_all(ctxt: &mut CommandContext) {
let mut other = HashMap::with_hasher(Default::default());
mem::swap(&mut *ctxt.framebuffer_objects.framebuffers.borrow_mut(), &mut other);
for (_, obj) in other.into_iter() {
obj.destroy(ctxt);
}
}
/// Destroys all framebuffer objects that contain a precise texture.
#[inline]
pub fn purge_texture(ctxt: &mut CommandContext, texture: gl::types::GLuint) {
FramebuffersContainer::purge_if(ctxt, |a| {
match a {
&RawAttachment::Texture { texture: id, .. } if id == texture => true,
_ => false
}
});
}
/// Destroys all framebuffer objects that contain a precise renderbuffer.
#[inline]
pub fn purge_renderbuffer(ctxt: &mut CommandContext, renderbuffer: gl::types::GLuint) {
FramebuffersContainer::purge_if(ctxt, |a| a == &RawAttachment::RenderBuffer(renderbuffer));
}
/// Destroys all framebuffer objects that match a certain condition.
fn purge_if<F>(ctxt: &mut CommandContext, condition: F)
where F: Fn(&RawAttachment) -> bool
{
let mut framebuffers = ctxt.framebuffer_objects.framebuffers.borrow_mut();
let mut attachments = Vec::with_capacity(0);
for (key, _) in framebuffers.iter() {
if key.color.iter().find(|&&(_, ref id)| condition(id)).is_some() {
attachments.push(key.clone());
continue;
}
if let Some(ref atch) = key.depth {
if condition(atch) {
attachments.push(key.clone());
continue;
}
}
if let Some(ref atch) = key.stencil {
if condition(atch) {
attachments.push(key.clone());
continue;
}
}
if let Some(ref atch) = key.depth_stencil {
if condition(atch) {
attachments.push(key.clone());
continue;
}
}
}
for atch in attachments.into_iter() {
framebuffers.remove(&atch).unwrap().destroy(ctxt);
}
}
/// Destroys all framebuffer objects.
///
/// This is very similar to `purge_all`, but optimized for when the container will soon
/// be destroyed.
pub fn cleanup(ctxt: &mut CommandContext) {
let mut other = HashMap::with_hasher(Default::default());
mem::swap(&mut *ctxt.framebuffer_objects.framebuffers.borrow_mut(), &mut other);
for (_, obj) in other.into_iter() {
obj.destroy(ctxt);
}
}
///
/// # Unsafety
///
/// After calling this function, you **must** make sure to call `purge_texture`
/// and/or `purge_renderbuffer` when one of the attachment is destroyed.
#[inline]
pub fn get_framebuffer_for_drawing(ctxt: &mut CommandContext,
attachments: Option<&ValidatedAttachments>)
-> gl::types::GLuint
{
if let Some(attachments) = attachments {
FramebuffersContainer::get_framebuffer(ctxt, attachments)
} else {
0
}
}
/// Binds the default framebuffer to `GL_READ_FRAMEBUFFER` or `GL_FRAMEBUFFER` so that it
/// becomes the target of `glReadPixels`, `glCopyTexImage2D`, etc.
// TODO: use an enum for the read buffer instead
#[inline]
pub fn bind_default_framebuffer_for_reading(ctxt: &mut CommandContext,
read_buffer: gl::types::GLenum)
{
unsafe { bind_framebuffer(ctxt, 0, false, true) };
unsafe { ctxt.gl.ReadBuffer(read_buffer) }; // TODO: cache
}
/// Binds a framebuffer to `GL_READ_FRAMEBUFFER` or `GL_FRAMEBUFFER` so that it becomes the
/// target of `glReadPixels`, `glCopyTexImage2D`, etc.
///
/// # Unsafety
///
/// After calling this function, you **must** make sure to call `purge_texture`
/// and/or `purge_renderbuffer` when one of the attachment is destroyed.
pub unsafe fn bind_framebuffer_for_reading(ctxt: &mut CommandContext, attachment: &RegularAttachment) {
// TODO: restore this optimisation
/*for (attachments, fbo) in ctxt.framebuffer_objects.framebuffers.borrow_mut().iter() {
for &(key, ref atc) in attachments.color.iter() {
if atc == attachment {
return (fbo.get_id(), gl::COLOR_ATTACHMENT0 + key);
}
}
}*/
let attachments = FramebufferAttachments::Regular(FramebufferSpecificAttachments {
colors: { let mut v = SmallVec::new(); v.push((0, attachment.clone())); v },
depth_stencil: DepthStencilAttachments::None,
}).validate(ctxt).unwrap();
let framebuffer = FramebuffersContainer::get_framebuffer_for_drawing(ctxt, Some(&attachments));
bind_framebuffer(ctxt, framebuffer, false, true);
ctxt.gl.ReadBuffer(gl::COLOR_ATTACHMENT0); // TODO: cache
}
/// Calls `glClearBuffer` on a framebuffer that contains the attachment.
///
/// # Panic
///
/// Panics if `data` is incompatible with the kind of attachment.
///
/// # Unsafety
///
/// After calling this function, you **must** make sure to call `purge_texture`
/// and/or `purge_renderbuffer` when one of the attachment is destroyed.
pub unsafe fn clear_buffer<D>(ctxt: &mut CommandContext, attachment: &RegularAttachment,
data: D)
where D: Into<ClearBufferData>
{
// TODO: look for an existing framebuffer with this attachment
let data = data.into();
let fb = FramebufferAttachments::Regular(FramebufferSpecificAttachments {
colors: { let mut v = SmallVec::new(); v.push((0, attachment.clone())); v },
depth_stencil: DepthStencilAttachments::None,
}).validate(ctxt).unwrap();
let fb = FramebuffersContainer::get_framebuffer_for_drawing(ctxt, Some(&fb));
// TODO: use DSA if supported
// TODO: what if glClearBuffer is not supported?
bind_framebuffer(ctxt, fb, true, false);
match (attachment.kind(), data) {
(TextureKind::Float, ClearBufferData::Float(data)) => {
ctxt.gl.ClearBufferfv(gl::COLOR, 0, data.as_ptr());
},
(TextureKind::Integral, ClearBufferData::Integral(data)) => {
ctxt.gl.ClearBufferiv(gl::COLOR, 0, data.as_ptr());
},
(TextureKind::Unsigned, ClearBufferData::Unsigned(data)) => {
ctxt.gl.ClearBufferuiv(gl::COLOR, 0, data.as_ptr());
},
(TextureKind::Depth, _) => {
unimplemented!() // TODO: can't work with the code above ^
},
(TextureKind::Stencil, _) => {
unimplemented!() // TODO: can't work with the code above ^
},
(TextureKind::DepthStencil, _) => {
unimplemented!() // TODO: can't work with the code above ^
},
_ => {
panic!("The data passed to `clear_buffer` does not match the kind of attachment");
}
}
}
///
/// # Unsafety
///
/// After calling this function, you **must** make sure to call `purge_texture`
/// and/or `purge_renderbuffer` when one of the attachment is destroyed.
fn get_framebuffer(ctxt: &mut CommandContext, attachments: &ValidatedAttachments)
-> gl::types::GLuint
{
// TODO: use entries API
let mut framebuffers = ctxt.framebuffer_objects.framebuffers.borrow_mut();
if let Some(value) = framebuffers.get(&attachments.raw) {
return value.id;
}
let new_fbo = FrameBufferObject::new(ctxt, &attachments.raw);
let new_fbo_id = new_fbo.id.clone();
framebuffers.insert(attachments.raw.clone(), new_fbo);
new_fbo_id
}
}
impl Drop for FramebuffersContainer {
#[inline]
fn drop(&mut self) {
if self.framebuffers.borrow().len() != 0 {
panic!()
}
}
}
/// A framebuffer object.
struct FrameBufferObject {
id: gl::types::GLuint,
current_read_buffer: gl::types::GLenum,
}
impl FrameBufferObject {
/// Builds a new FBO.
///
/// # Panic
///
/// Panics if anything wrong or not supported is detected with the raw attachments.
///
fn new(mut ctxt: &mut CommandContext, attachments: &RawAttachments) -> FrameBufferObject {
if attachments.color.len() > ctxt.capabilities.max_draw_buffers as usize {
panic!("Trying to attach {} color buffers, but the hardware only supports {}",
attachments.color.len(), ctxt.capabilities.max_draw_buffers);
}
// building the FBO
let id = unsafe {
let mut id = mem::uninitialized();
if ctxt.version >= &Version(Api::Gl, 4, 5) ||
ctxt.extensions.gl_arb_direct_state_access
{
ctxt.gl.CreateFramebuffers(1, &mut id);
} else if ctxt.version >= &Version(Api::Gl, 3, 0) ||
ctxt.version >= &Version(Api::GlEs, 2, 0) ||
ctxt.extensions.gl_arb_framebuffer_object
{
ctxt.gl.GenFramebuffers(1, &mut id);
bind_framebuffer(&mut ctxt, id, true, false);
} else if ctxt.extensions.gl_ext_framebuffer_object {
ctxt.gl.GenFramebuffersEXT(1, &mut id);
bind_framebuffer(&mut ctxt, id, true, false);
} else {
// glium doesn't allow creating contexts that don't support FBOs
unreachable!();
}
id
};
// framebuffer parameters
// TODO: DSA
if let Some(width) = attachments.default_width {
unsafe { bind_framebuffer(&mut ctxt, id, true, false) }; // TODO: remove once DSA is used
if ctxt.version >= &Version(Api::Gl, 4, 3) || ctxt.version >= &Version(Api::GlEs, 3, 1) ||
ctxt.extensions.gl_arb_framebuffer_no_attachments
{
unsafe {
ctxt.gl.FramebufferParameteri(gl::DRAW_FRAMEBUFFER, gl::FRAMEBUFFER_DEFAULT_WIDTH,
width as gl::types::GLint);
}
} else {
unreachable!();
}
}
if let Some(height) = attachments.default_height {
unsafe { bind_framebuffer(&mut ctxt, id, true, false) }; // TODO: remove once DSA is used
if ctxt.version >= &Version(Api::Gl, 4, 3) || ctxt.version >= &Version(Api::GlEs, 3, 1) ||
ctxt.extensions.gl_arb_framebuffer_no_attachments
{
unsafe {
ctxt.gl.FramebufferParameteri(gl::DRAW_FRAMEBUFFER, gl::FRAMEBUFFER_DEFAULT_HEIGHT,
height as gl::types::GLint);
}
} else {
unreachable!();
}
}
if let Some(layers) = attachments.default_layers {
unsafe { bind_framebuffer(&mut ctxt, id, true, false) }; // TODO: remove once DSA is used
if ctxt.version >= &Version(Api::Gl, 4, 3) || ctxt.version >= &Version(Api::GlEs, 3, 2) ||
ctxt.extensions.gl_arb_framebuffer_no_attachments
{
unsafe {
ctxt.gl.FramebufferParameteri(gl::DRAW_FRAMEBUFFER, gl::FRAMEBUFFER_DEFAULT_LAYERS,
layers as gl::types::GLint);
}
} else {
unreachable!();
}
}
if let Some(samples) = attachments.default_samples {
unsafe { bind_framebuffer(&mut ctxt, id, true, false) }; // TODO: remove once DSA is used
if ctxt.version >= &Version(Api::Gl, 4, 3) || ctxt.version >= &Version(Api::GlEs, 3, 1) ||
ctxt.extensions.gl_arb_framebuffer_no_attachments
{
unsafe {
ctxt.gl.FramebufferParameteri(gl::DRAW_FRAMEBUFFER, gl::FRAMEBUFFER_DEFAULT_SAMPLES,
samples as gl::types::GLint);
}
} else {
unreachable!();
}
}
if let Some(samples_fixed) = attachments.default_samples_fixed {
unsafe { bind_framebuffer(&mut ctxt, id, true, false) }; // TODO: remove once DSA is used
if ctxt.version >= &Version(Api::Gl, 4, 3) || ctxt.version >= &Version(Api::GlEs, 3, 1) ||
ctxt.extensions.gl_arb_framebuffer_no_attachments
{
unsafe {
ctxt.gl.FramebufferParameteri(gl::DRAW_FRAMEBUFFER, gl::FRAMEBUFFER_DEFAULT_FIXED_SAMPLE_LOCATIONS,
if samples_fixed { 1 } else { 0 });
}
} else {
unreachable!();
}
}
// attaching the attachments, and building the list of enums to pass to `glDrawBuffers`
let mut raw_attachments = Vec::with_capacity(attachments.color.len());
for (attachment_pos, &(pos_in_drawbuffers, atchmnt)) in attachments.color.iter().enumerate() {
if attachment_pos >= ctxt.capabilities.max_color_attachments as usize {
panic!("Trying to attach a color buffer to slot {}, but the hardware only supports {} bind points",
attachment_pos, ctxt.capabilities.max_color_attachments);
}
unsafe { attach(&mut ctxt, gl::COLOR_ATTACHMENT0 + attachment_pos as u32, id, atchmnt) };
while raw_attachments.len() <= pos_in_drawbuffers as usize { raw_attachments.push(gl::NONE); }
raw_attachments[pos_in_drawbuffers as usize] = gl::COLOR_ATTACHMENT0 + attachment_pos as u32;
}
if let Some(depth) = attachments.depth {
unsafe { attach(&mut ctxt, gl::DEPTH_ATTACHMENT, id, depth) };
}
if let Some(stencil) = attachments.stencil {
unsafe { attach(&mut ctxt, gl::STENCIL_ATTACHMENT, id, stencil) };
}
if let Some(depth_stencil) = attachments.depth_stencil {
unsafe { attach(&mut ctxt, gl::DEPTH_STENCIL_ATTACHMENT, id, depth_stencil) };
}
// calling `glDrawBuffers` if necessary
if raw_attachments != &[gl::COLOR_ATTACHMENT0] {
if ctxt.version >= &Version(Api::Gl, 4, 5) ||
ctxt.extensions.gl_arb_direct_state_access
{
unsafe {
ctxt.gl.NamedFramebufferDrawBuffers(id, raw_attachments.len()
as gl::types::GLsizei,
raw_attachments.as_ptr());
}
} else if ctxt.version >= &Version(Api::Gl, 2, 0) ||
ctxt.version >= &Version(Api::GlEs, 3, 0)
{
unsafe {
bind_framebuffer(&mut ctxt, id, true, false);
ctxt.gl.DrawBuffers(raw_attachments.len() as gl::types::GLsizei,
raw_attachments.as_ptr());
}
} else if ctxt.extensions.gl_arb_draw_buffers {
unsafe {
bind_framebuffer(&mut ctxt, id, true, false);
ctxt.gl.DrawBuffersARB(raw_attachments.len() as gl::types::GLsizei,
raw_attachments.as_ptr());
}
} else if ctxt.extensions.gl_ati_draw_buffers {
unsafe {
bind_framebuffer(&mut ctxt, id, true, false);
ctxt.gl.DrawBuffersATI(raw_attachments.len() as gl::types::GLsizei,
raw_attachments.as_ptr());
}
} else {
// OpenGL ES 2 and OpenGL 1 don't support calling `glDrawBuffers`
panic!("Using more than one attachment is not supported by the backend");
}
}
FrameBufferObject {
id: id,
current_read_buffer: gl::BACK,
}
}
/// Destroys the FBO. Must be called, or things will leak.
fn destroy(self, ctxt: &mut CommandContext) {
// unbinding framebuffer
if ctxt.state.draw_framebuffer == self.id {
ctxt.state.draw_framebuffer = 0;
}
if ctxt.state.read_framebuffer == self.id {
ctxt.state.read_framebuffer = 0;
}
// deleting
if ctxt.version >= &Version(Api::Gl, 3, 0) ||
ctxt.version >= &Version(Api::GlEs, 2, 0) ||
ctxt.extensions.gl_arb_framebuffer_object
{
unsafe { ctxt.gl.DeleteFramebuffers(1, [ self.id ].as_ptr()) };
} else if ctxt.extensions.gl_ext_framebuffer_object {
unsafe { ctxt.gl.DeleteFramebuffersEXT(1, [ self.id ].as_ptr()) };
} else {
unreachable!();
}
}
}
impl GlObject for FrameBufferObject {
type Id = gl::types::GLuint;
#[inline]
fn get_id(&self) -> gl::types::GLuint {
self.id
}
}
/// Binds a framebuffer object, either for drawing, reading, or both.
///
/// # Safety
///
/// The id of the FBO must be valid.
///
pub unsafe fn bind_framebuffer(ctxt: &mut CommandContext, fbo_id: gl::types::GLuint,
draw: bool, read: bool)
{
if draw && read {
if ctxt.state.draw_framebuffer != fbo_id || ctxt.state.read_framebuffer != fbo_id {
if ctxt.version >= &Version(Api::Gl, 3, 0) ||
ctxt.version >= &Version(Api::GlEs, 2, 0) ||
ctxt.extensions.gl_arb_framebuffer_object
{
ctxt.gl.BindFramebuffer(gl::FRAMEBUFFER, fbo_id);
ctxt.state.draw_framebuffer = fbo_id;
ctxt.state.read_framebuffer = fbo_id;
} else if ctxt.extensions.gl_ext_framebuffer_object {
ctxt.gl.BindFramebufferEXT(gl::FRAMEBUFFER_EXT, fbo_id);
ctxt.state.draw_framebuffer = fbo_id;
ctxt.state.read_framebuffer = fbo_id;
} else {
unreachable!();
}
}
} else {
if draw && ctxt.state.draw_framebuffer != fbo_id {
if ctxt.version >= &Version(Api::Gl, 3, 0) ||
ctxt.extensions.gl_arb_framebuffer_object
{
ctxt.gl.BindFramebuffer(gl::DRAW_FRAMEBUFFER, fbo_id);
ctxt.state.draw_framebuffer = fbo_id;
} else if ctxt.version >= &Version(Api::GlEs, 2, 0) {
ctxt.gl.BindFramebuffer(gl::FRAMEBUFFER, fbo_id);
ctxt.state.draw_framebuffer = fbo_id;
ctxt.state.read_framebuffer = fbo_id;
} else if ctxt.extensions.gl_ext_framebuffer_object {
ctxt.gl.BindFramebufferEXT(gl::FRAMEBUFFER_EXT, fbo_id);
ctxt.state.draw_framebuffer = fbo_id;
ctxt.state.read_framebuffer = fbo_id;
} else {
unreachable!();
}
}
if read && ctxt.state.read_framebuffer != fbo_id {
if ctxt.version >= &Version(Api::Gl, 3, 0) ||
ctxt.extensions.gl_arb_framebuffer_object
{
ctxt.gl.BindFramebuffer(gl::READ_FRAMEBUFFER, fbo_id);
ctxt.state.read_framebuffer = fbo_id;
} else if ctxt.version >= &Version(Api::GlEs, 2, 0) {
ctxt.gl.BindFramebuffer(gl::FRAMEBUFFER, fbo_id);
ctxt.state.draw_framebuffer = fbo_id;
ctxt.state.read_framebuffer = fbo_id;
} else if ctxt.extensions.gl_ext_framebuffer_object {
ctxt.gl.BindFramebufferEXT(gl::FRAMEBUFFER_EXT, fbo_id);
ctxt.state.draw_framebuffer = fbo_id;
ctxt.state.read_framebuffer = fbo_id;
} else {
unreachable!();
}
}
}
}
/// Attaches something to a framebuffer object.
///
/// # Panic
///
/// - Panics if `layer` is `None` and layered attachments are not supported.
/// - Panics if `layer` is `None` and the texture is not an array or a 3D texture.
/// - Panics if the texture is an array and attaching an array is not supported.
///
/// # Safety
///
/// All parameters must be valid.
///
unsafe fn attach(ctxt: &mut CommandContext, slot: gl::types::GLenum,
id: gl::types::GLuint, attachment: RawAttachment)
{
match attachment {
RawAttachment::Texture { texture: tex_id, level, layer, bind_point, cubemap_layer } => {
match bind_point {
// these textures can't be layered
gl::TEXTURE_2D | gl::TEXTURE_2D_MULTISAMPLE | gl::TEXTURE_1D |
gl::TEXTURE_RECTANGLE =>
{
assert_eq!(layer, Some(0));
debug_assert!(cubemap_layer.is_none());
if ctxt.version >= &Version(Api::Gl, 4, 5) ||
ctxt.extensions.gl_arb_direct_state_access
{
ctxt.gl.NamedFramebufferTexture(id, slot, tex_id,
level as gl::types::GLint);
} else if ctxt.extensions.gl_ext_direct_state_access &&
ctxt.extensions.gl_ext_geometry_shader4
{
ctxt.gl.NamedFramebufferTextureEXT(id, slot, tex_id,
level as gl::types::GLint);
} else if ctxt.version >= &Version(Api::Gl, 3, 2) {
bind_framebuffer(ctxt, id, true, false);
ctxt.gl.FramebufferTexture(gl::DRAW_FRAMEBUFFER,
slot, tex_id, level as gl::types::GLint);
} else if ctxt.version >= &Version(Api::Gl, 3, 0) ||
ctxt.extensions.gl_arb_framebuffer_object
{
bind_framebuffer(ctxt, id, true, false);
match bind_point {
gl::TEXTURE_1D | gl::TEXTURE_RECTANGLE => {
ctxt.gl.FramebufferTexture1D(gl::DRAW_FRAMEBUFFER,
slot, bind_point, tex_id,
level as gl::types::GLint);
},
gl::TEXTURE_2D | gl::TEXTURE_2D_MULTISAMPLE => {
ctxt.gl.FramebufferTexture2D(gl::DRAW_FRAMEBUFFER,
slot, bind_point, tex_id,
level as gl::types::GLint);
},
_ => unreachable!()
}
} else if ctxt.version >= &Version(Api::GlEs, 2, 0) {
bind_framebuffer(ctxt, id, true, true);
assert!(bind_point == gl::TEXTURE_2D);
ctxt.gl.FramebufferTexture2D(gl::FRAMEBUFFER, slot, bind_point, tex_id,
level as gl::types::GLint);
} else if ctxt.extensions.gl_ext_framebuffer_object {
bind_framebuffer(ctxt, id, true, true);
match bind_point {
gl::TEXTURE_1D | gl::TEXTURE_RECTANGLE => {
ctxt.gl.FramebufferTexture1DEXT(gl::FRAMEBUFFER_EXT,
slot, bind_point, tex_id,
level as gl::types::GLint);
},
gl::TEXTURE_2D | gl::TEXTURE_2D_MULTISAMPLE => {
ctxt.gl.FramebufferTexture2DEXT(gl::FRAMEBUFFER_EXT,
slot, bind_point, tex_id,
level as gl::types::GLint);
},
_ => unreachable!()
}
} else {
// it's not possible to create an OpenGL context that doesn't support FBOs
unreachable!();
}
},
// non-layered attachments
gl::TEXTURE_1D_ARRAY | gl::TEXTURE_2D_ARRAY | gl::TEXTURE_2D_MULTISAMPLE_ARRAY |
gl::TEXTURE_3D | gl::TEXTURE_CUBE_MAP_ARRAY if layer.is_some() =>
{
let layer = if bind_point == gl::TEXTURE_CUBE_MAP_ARRAY {
layer.unwrap() * 6 + cubemap_layer.unwrap().get_layer_index()
as gl::types::GLenum
} else {
layer.unwrap()
};
if ctxt.version >= &Version(Api::Gl, 4, 5) ||
ctxt.extensions.gl_arb_direct_state_access
{
ctxt.gl.NamedFramebufferTextureLayer(id, slot, tex_id,
level as gl::types::GLint,
layer as gl::types::GLint);
} else if ctxt.extensions.gl_ext_direct_state_access &&
ctxt.extensions.gl_ext_geometry_shader4
{
ctxt.gl.NamedFramebufferTextureLayerEXT(id, slot, tex_id,
level as gl::types::GLint,
layer as gl::types::GLint);
} else if ctxt.version >= &Version(Api::Gl, 3, 0) ||
ctxt.extensions.gl_arb_framebuffer_object
{
bind_framebuffer(ctxt, id, true, false);
match bind_point {
gl::TEXTURE_1D_ARRAY | gl::TEXTURE_2D_ARRAY |
gl::TEXTURE_2D_MULTISAMPLE_ARRAY => {
ctxt.gl.FramebufferTextureLayer(gl::DRAW_FRAMEBUFFER,
slot, tex_id,
level as gl::types::GLint,
layer as gl::types::GLint);
},
gl::TEXTURE_3D => {
ctxt.gl.FramebufferTexture3D(gl::DRAW_FRAMEBUFFER,
slot, bind_point, tex_id,
level as gl::types::GLint,
layer as gl::types::GLint);
},
_ => unreachable!()
}
} else if ctxt.extensions.gl_ext_framebuffer_object &&
bind_point == gl::TEXTURE_3D
{
bind_framebuffer(ctxt, id, true, true);
ctxt.gl.FramebufferTexture3DEXT(gl::FRAMEBUFFER_EXT,
slot, bind_point, tex_id,
level as gl::types::GLint,
layer as gl::types::GLint);
} else if ctxt.extensions.gl_ext_texture_array &&
bind_point == gl::TEXTURE_1D_ARRAY ||
bind_point == gl::TEXTURE_2D_ARRAY ||
bind_point == gl::TEXTURE_2D_MULTISAMPLE_ARRAY
{
bind_framebuffer(ctxt, id, true, false);
ctxt.gl.FramebufferTextureLayerEXT(gl::DRAW_FRAMEBUFFER,
slot, tex_id,
level as gl::types::GLint,
layer as gl::types::GLint);
} else {
panic!("Attaching a texture array is not supported");
}
},
// layered attachments
gl::TEXTURE_1D_ARRAY | gl::TEXTURE_2D_ARRAY | gl::TEXTURE_2D_MULTISAMPLE_ARRAY |
gl::TEXTURE_3D | gl::TEXTURE_CUBE_MAP_ARRAY if layer.is_none() =>
{
if ctxt.version >= &Version(Api::Gl, 4, 5) ||
ctxt.extensions.gl_arb_direct_state_access
{
ctxt.gl.NamedFramebufferTexture(id, slot, tex_id,
level as gl::types::GLint);
} else if ctxt.extensions.gl_ext_direct_state_access &&
ctxt.extensions.gl_ext_geometry_shader4
{
ctxt.gl.NamedFramebufferTextureEXT(id, slot, tex_id,
level as gl::types::GLint);
} else if ctxt.version >= &Version(Api::Gl, 3, 2) {
bind_framebuffer(ctxt, id, true, false);
ctxt.gl.FramebufferTexture(gl::DRAW_FRAMEBUFFER,
slot, tex_id, level as gl::types::GLint);
} else {
// note that this should have been detected earlier
panic!("Layered framebuffers are not supported");
}
},
// non-layered cubemaps
gl::TEXTURE_CUBE_MAP if layer.is_some() => {
let bind_point = gl::TEXTURE_CUBE_MAP_POSITIVE_X +
cubemap_layer.unwrap().get_layer_index() as gl::types::GLenum;
if ctxt.version >= &Version(Api::Gl, 3, 0) ||
ctxt.extensions.gl_arb_framebuffer_object
{
bind_framebuffer(ctxt, id, true, false);
ctxt.gl.FramebufferTexture2D(gl::DRAW_FRAMEBUFFER,
slot, bind_point, tex_id,
level as gl::types::GLint);
} else if ctxt.version >= &Version(Api::GlEs, 2, 0) {
bind_framebuffer(ctxt, id, true, true);
ctxt.gl.FramebufferTexture2D(gl::FRAMEBUFFER, slot, bind_point, tex_id,
level as gl::types::GLint);
} else if ctxt.extensions.gl_ext_framebuffer_object {
bind_framebuffer(ctxt, id, true, true);
ctxt.gl.FramebufferTexture2DEXT(gl::FRAMEBUFFER_EXT,
slot, bind_point, tex_id,
level as gl::types::GLint);
} else {
// it's not possible to create an OpenGL context that doesn't support FBOs
unreachable!();
}
},
// layered cubemaps
gl::TEXTURE_CUBE_MAP if layer.is_none() => {
if ctxt.version >= &Version(Api::Gl, 4, 5) ||
ctxt.extensions.gl_arb_direct_state_access
{
ctxt.gl.NamedFramebufferTexture(id, slot, tex_id,
level as gl::types::GLint);
} else if ctxt.extensions.gl_ext_direct_state_access &&
ctxt.extensions.gl_ext_geometry_shader4
{
ctxt.gl.NamedFramebufferTextureEXT(id, slot, tex_id,
level as gl::types::GLint);
} else if ctxt.version >= &Version(Api::Gl, 3, 2) {
bind_framebuffer(ctxt, id, true, false);
ctxt.gl.FramebufferTexture(gl::DRAW_FRAMEBUFFER,
slot, tex_id, level as gl::types::GLint);
} else {
// note that this should have been detected earlier
panic!("Layered framebuffers are not supported");
}
},
_ => unreachable!()
}
},
// renderbuffers are straight-forward
RawAttachment::RenderBuffer(renderbuffer) => {
if ctxt.version >= &Version(Api::Gl, 4, 5) ||
ctxt.extensions.gl_arb_direct_state_access
{
ctxt.gl.NamedFramebufferRenderbuffer(id, slot, gl::RENDERBUFFER, renderbuffer);
} else if ctxt.extensions.gl_ext_direct_state_access &&
ctxt.extensions.gl_ext_geometry_shader4
{
ctxt.gl.NamedFramebufferRenderbufferEXT(id, slot, gl::RENDERBUFFER, renderbuffer);
} else if ctxt.version >= &Version(Api::Gl, 3, 0) ||
ctxt.extensions.gl_arb_framebuffer_object
{
bind_framebuffer(ctxt, id, true, false);
ctxt.gl.FramebufferRenderbuffer(gl::DRAW_FRAMEBUFFER, slot,
gl::RENDERBUFFER, renderbuffer);
} else if ctxt.version >= &Version(Api::GlEs, 2, 0) {
bind_framebuffer(ctxt, id, true, true);
ctxt.gl.FramebufferRenderbuffer(gl::DRAW_FRAMEBUFFER, slot,
gl::RENDERBUFFER, renderbuffer);
} else if ctxt.extensions.gl_ext_framebuffer_object {
bind_framebuffer(ctxt, id, true, true);
ctxt.gl.FramebufferRenderbufferEXT(gl::DRAW_FRAMEBUFFER, slot,
gl::RENDERBUFFER, renderbuffer);
} else {
// it's not possible to create an OpenGL context that doesn't support FBOs
unreachable!();
}
},
}
}