Struct vulkano::pipeline::graphics::multisample::MultisampleState

pub struct MultisampleState {
    pub rasterization_samples: SampleCount,
    pub sample_shading: Option<f32>,
    pub sample_mask: [u32; 2],
    pub alpha_to_coverage_enable: bool,
    pub alpha_to_one_enable: bool,
    pub _ne: NonExhaustive,
}

State of the multisampling.

Fields

rasterization_samples: SampleCount

The number of rasterization samples to take per pixel. The GPU will pick this many different locations within each pixel and assign to each of these locations a different depth value. The depth and stencil test will then be run for each sample.

The default value is SampleCount::Sample1.

sample_shading: Option<f32>

Controls the proportion (between 0.0 and 1.0) of the samples that will be run through the fragment shader.

If the value is 1.0, then all sub-pixel samples will run through the shader and get a different value. If the value is 0.5, about half of the samples will run through the shader and the other half will get their values from the ones which went through the shader.

If set to Some, the sample_rate_shading feature must be enabled on the device.

The default value is None.

sample_mask: [u32; 2]

A mask of bits that is ANDed with the coverage mask of each set of rasterization_samples samples. Only the first rasterization_samples / 32 bits are used, the rest is ignored.

The default value is [u32::MAX; 2].

alpha_to_coverage_enable: bool

Controls whether the alpha value of the fragment will be used in an implementation-defined way to determine which samples get disabled or not. For example if the alpha value is 0.5, then about half of the samples will be discarded. If you render to a multisample image, this means that the color will end up being mixed with whatever color was underneath, which gives the same effect as alpha blending.

The default value is false.

alpha_to_one_enable: bool

Controls whether the alpha value of all the samples will be forced to 1.0 (or the maximum possible value) after the effects of alpha_to_coverage have been applied.

If set to true, the alpha_to_one feature must be enabled on the device.

The default value is false.

_ne: NonExhaustive

Implementations

impl MultisampleState

pub fn new() -> MultisampleState

👎Deprecated since 0.34.0: use MultisampleState::default instead

Creates a MultisampleState with multisampling disabled.

Trait Implementations

impl Clone for MultisampleState

fn clone(&self) -> MultisampleState

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MultisampleState

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for MultisampleState

fn default() -> Self

Returns the “default value” for a type.

impl Copy for MultisampleState