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
// Copyright (c) 2016 The vulkano developers
// Licensed under the Apache License, Version 2.0
// <LICENSE-APACHE or
// https://www.apache.org/licenses/LICENSE-2.0> or the MIT
// license <LICENSE-MIT or https://opensource.org/licenses/MIT>,
// at your option. All files in the project carrying such
// notice may not be copied, modified, or distributed except
// according to those terms.
//! Configures how input vertices are assembled into primitives.
use crate::{
device::Device, macros::vulkan_enum, Requires, RequiresAllOf, RequiresOneOf, ValidationError,
};
/// The state in a graphics pipeline describing how the input assembly stage should behave.
#[derive(Clone, Copy, Debug)]
pub struct InputAssemblyState {
/// The type of primitives.
///
/// When [`DynamicState::PrimitiveTopology`] is used, if the
/// [`dynamic_primitive_topology_unrestricted`] device property is `false`, then
/// the dynamically set primitive topology must belong to the same *topology class* as
/// `topology`.
/// In practice, this is simply the first word in the name of the topology.
///
/// The default value is [`PrimitiveTopology::TriangleList`].
///
/// [`DynamicState::PrimitiveTopology`]: crate::pipeline::DynamicState::PrimitiveTopology
/// [`dynamic_primitive_topology_unrestricted`]: crate::device::Properties::dynamic_primitive_topology_unrestricted
pub topology: PrimitiveTopology,
/// If true, then when drawing with an index buffer, the special index value consisting of the
/// maximum unsigned value (`0xff`, `0xffff` or `0xffffffff`) will tell the GPU that it is the
/// end of the current primitive. A new primitive will restart at the next index.
///
/// Primitive restart is mostly useful in combination with "strip" and "fan" topologies. "List"
/// topologies require a feature to be enabled on the device when combined with primitive
/// restart.
///
/// The default value is `false`.
pub primitive_restart_enable: bool,
pub _ne: crate::NonExhaustive,
}
impl Default for InputAssemblyState {
/// Returns [`InputAssemblyState::new()`].
#[inline]
fn default() -> Self {
Self {
topology: PrimitiveTopology::TriangleList,
primitive_restart_enable: false,
_ne: crate::NonExhaustive(()),
}
}
}
impl InputAssemblyState {
/// Creates an `InputAssemblyState` with the `TriangleList` topology and primitive restart
/// disabled.
#[inline]
#[deprecated(since = "0.34.0", note = "use `InputAssemblyState::default` instead")]
pub fn new() -> Self {
Self {
topology: PrimitiveTopology::TriangleList,
primitive_restart_enable: false,
_ne: crate::NonExhaustive(()),
}
}
/// Sets the primitive topology.
#[inline]
#[deprecated(since = "0.34.0")]
pub fn topology(mut self, topology: PrimitiveTopology) -> Self {
self.topology = topology;
self
}
/// Enables primitive restart.
#[inline]
#[deprecated(since = "0.34.0")]
pub fn primitive_restart_enable(mut self) -> Self {
self.primitive_restart_enable = true;
self
}
#[allow(clippy::trivially_copy_pass_by_ref)]
pub(crate) fn validate(&self, device: &Device) -> Result<(), Box<ValidationError>> {
let &Self {
topology,
primitive_restart_enable,
_ne: _,
} = self;
topology.validate_device(device).map_err(|err| {
err.add_context("topology")
.set_vuids(&["VUID-VkPipelineInputAssemblyStateCreateInfo-topology-parameter"])
})?;
match topology {
PrimitiveTopology::TriangleFan => {
if device.enabled_extensions().khr_portability_subset
&& !device.enabled_features().triangle_fans
{
return Err(Box::new(ValidationError {
problem: "this device is a portability subset device, and \
`topology` is `PrimitiveTopology::TriangleFan`"
.into(),
requires_one_of: RequiresOneOf(&[RequiresAllOf(&[Requires::Feature(
"triangle_fans",
)])]),
vuids: &["VUID-VkPipelineInputAssemblyStateCreateInfo-triangleFans-04452"],
..Default::default()
}));
}
}
PrimitiveTopology::LineListWithAdjacency
| PrimitiveTopology::LineStripWithAdjacency
| PrimitiveTopology::TriangleListWithAdjacency
| PrimitiveTopology::TriangleStripWithAdjacency => {
if !device.enabled_features().geometry_shader {
return Err(Box::new(ValidationError {
context: "topology".into(),
problem: "is `PrimitiveTopology::*WithAdjacency`".into(),
requires_one_of: RequiresOneOf(&[RequiresAllOf(&[Requires::Feature(
"geometry_shader",
)])]),
vuids: &["VUID-VkPipelineInputAssemblyStateCreateInfo-topology-00429"],
}));
}
}
PrimitiveTopology::PatchList => {
if !device.enabled_features().tessellation_shader {
return Err(Box::new(ValidationError {
context: "topology".into(),
problem: "is `PrimitiveTopology::PatchList`".into(),
requires_one_of: RequiresOneOf(&[RequiresAllOf(&[Requires::Feature(
"tessellation_shader",
)])]),
vuids: &["VUID-VkPipelineInputAssemblyStateCreateInfo-topology-00430"],
}));
}
}
_ => (),
}
if primitive_restart_enable {
match topology {
PrimitiveTopology::PointList
| PrimitiveTopology::LineList
| PrimitiveTopology::TriangleList
| PrimitiveTopology::LineListWithAdjacency
| PrimitiveTopology::TriangleListWithAdjacency => {
if !device.enabled_features().primitive_topology_list_restart {
return Err(Box::new(ValidationError {
problem: "`topology` is `PrimitiveTopology::*List`, and \
`primitive_restart_enable` is `true`"
.into(),
requires_one_of: RequiresOneOf(&[RequiresAllOf(&[Requires::Feature(
"primitive_topology_list_restart",
)])]),
vuids: &["VUID-VkPipelineInputAssemblyStateCreateInfo-topology-06252"],
..Default::default()
}));
}
}
PrimitiveTopology::PatchList => {
if !device
.enabled_features()
.primitive_topology_patch_list_restart
{
return Err(Box::new(ValidationError {
problem: "`topology` is `PrimitiveTopology::PatchList`, and \
`primitive_restart_enable` is `true`"
.into(),
requires_one_of: RequiresOneOf(&[RequiresAllOf(&[Requires::Feature(
"primitive_topology_patch_list_restart",
)])]),
vuids: &["VUID-VkPipelineInputAssemblyStateCreateInfo-topology-06253"],
..Default::default()
}));
}
}
_ => (),
}
}
Ok(())
}
}
vulkan_enum! {
#[non_exhaustive]
/// Describes how vertices must be grouped together to form primitives.
///
/// When [`DynamicState::PrimitiveTopology`] is used, if the
/// [`dynamic_primitive_topology_unrestricted`] device property is `false`, then
/// the dynamically set primitive topology must belong to the same *topology class* as what
/// was set during pipeline creation.
/// In practice, this is simply the first word in the name of the topology.
///
/// When enabling primitive restart, "list" topologies require a feature to be enabled on the
/// device:
/// - The `PatchList` topology requires the
/// [`primitive_topology_patch_list_restart`](crate::device::Features::primitive_topology_patch_list_restart)
/// feature.
/// - All other "list" topologies require the
/// [`primitive_topology_list_restart`](crate::device::Features::primitive_topology_list_restart)
/// feature.
///
/// [`DynamicState::PrimitiveTopology`]: crate::pipeline::DynamicState::PrimitiveTopology
/// [`dynamic_primitive_topology_unrestricted`]: crate::device::Properties::dynamic_primitive_topology_unrestricted
PrimitiveTopology = PrimitiveTopology(i32);
/// A series of separate point primitives.
///
/// Topology class: Point
PointList = POINT_LIST,
/// A series of separate line primitives.
///
/// Topology class: Line
LineList = LINE_LIST,
/// A series of consecutive line primitives, with consecutive lines sharing a vertex.
///
/// Topology class: Line
LineStrip = LINE_STRIP,
/// A series of separate triangle primitives.
///
/// Topology class: Triangle
TriangleList = TRIANGLE_LIST,
/// A series of consecutive triangle primitives, with consecutive triangles sharing an edge (two vertices).
///
/// Topology class: Triangle
TriangleStrip = TRIANGLE_STRIP,
/// A series of consecutive triangle primitives, with all triangles sharing a common vertex (the first).
///
/// On [portability subset](crate::instance#portability-subset-devices-and-the-enumerate_portability-flag)
/// devices, the [`triangle_fans`](crate::device::Features::triangle_fans)
/// feature must be enabled on the device.
///
/// Topology class: Triangle
TriangleFan = TRIANGLE_FAN,
/// As `LineList, but with adjacency, used in combination with geometry shaders. Requires the
/// [`geometry_shader`](crate::device::Features::geometry_shader) feature.
///
/// Topology class: Line
LineListWithAdjacency = LINE_LIST_WITH_ADJACENCY,
/// As `LineStrip`, but with adjacency, used in combination with geometry shaders. Requires the
/// [`geometry_shader`](crate::device::Features::geometry_shader) feature.
///
/// Topology class: Line
LineStripWithAdjacency = LINE_STRIP_WITH_ADJACENCY,
/// As `TriangleList`, but with adjacency, used in combination with geometry shaders. Requires
/// the [`geometry_shader`](crate::device::Features::geometry_shader) feature.
///
/// Topology class: Triangle
TriangleListWithAdjacency = TRIANGLE_LIST_WITH_ADJACENCY,
/// As `TriangleStrip`, but with adjacency, used in combination with geometry shaders. Requires
/// the [`geometry_shader`](crate::device::Features::geometry_shader) feature.
///
/// Topology class: Triangle
TriangleStripWithAdjacency = TRIANGLE_STRIP_WITH_ADJACENCY,
/// Separate patch primitives, used in combination with tessellation shaders. Requires the
/// [`tessellation_shader`](crate::device::Features::tessellation_shader) feature.
///
/// Topology class: Patch
PatchList = PATCH_LIST,
}
// TODO: use the #[default] attribute once it's stable.
// See: https://github.com/rust-lang/rust/issues/87517
impl Default for PrimitiveTopology {
#[inline]
fn default() -> Self {
PrimitiveTopology::TriangleList
}
}