Struct vulkano::pipeline::graphics::color_blend::ColorBlendState

pub struct ColorBlendState {
    pub logic_op: Option<StateMode<LogicOp>>,
    pub attachments: Vec<ColorBlendAttachmentState>,
    pub blend_constants: StateMode<[f32; 4]>,
}

Describes how the color output of the fragment shader is written to the attachment. See the documentation of the blend module for more info.

Fields

logic_op: Option<StateMode<LogicOp>>

Sets the logical operation to perform between the incoming fragment color and the existing fragment in the framebuffer attachment.

If set to Some, the logic_op feature must be enabled on the device. If set to Some(Dynamic), then the extended_dynamic_state2_logic_op feature must also be enabled on the device.

attachments: Vec<ColorBlendAttachmentState>

Sets the blend and output state for each color attachment. The number of elements must match the number of color attachments in the framebuffer.

If there are multiple elements, and the blend and color_write_mask members of each element differ, then the independent_blend feature must be enabled on the device.

blend_constants: StateMode<[f32; 4]>

The constant color to use for some of the BlendFactor variants.

Implementations

impl ColorBlendState

pub fn new(num: u32) -> Self

Creates a ColorBlendState with logical operations disabled, blend constants set to zero, and num attachment entries that have blending disabled, and color write and all color components enabled.

pub fn logic_op(self, logic_op: LogicOp) -> Self

Enables logical operations with the given logical operation.

pub fn logic_op_dynamic(self) -> Self

Enables logical operations with a dynamic logical operation.

pub fn blend(self, blend: AttachmentBlend) -> Self

Enables blending for all attachments, with the given parameters.

pub fn blend_alpha(self) -> Self

Enables blending for all attachments, with alpha blending.

pub fn blend_additive(self) -> Self

Enables blending for all attachments, with additive blending.

pub fn color_write_mask(self, color_write_mask: ColorComponents) -> Self

Sets the color write mask for all attachments.

pub fn blend_constants(self, constants: [f32; 4]) -> Self

Sets the blend constants.

pub fn blend_constants_dynamic(self) -> Self

Sets the blend constants as dynamic.

Trait Implementations

impl Clone for ColorBlendState

fn clone(&self) -> ColorBlendState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ColorBlendState

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

Formats the value using the given formatter.

impl Default for ColorBlendState

fn default() -> Self

Returns [ColorBlendState::new(1)].