Enum vulkano::pipeline::graphics::viewport::ViewportState

pub enum ViewportState {
    Fixed {
        data: Vec<(Viewport, Scissor)>,
    },
    FixedViewport {
        viewports: Vec<Viewport>,
        scissor_count_dynamic: bool,
    },
    FixedScissor {
        scissors: Vec<Scissor>,
        viewport_count_dynamic: bool,
    },
    Dynamic {
        count: u32,
        viewport_count_dynamic: bool,
        scissor_count_dynamic: bool,
    },
}

List of viewports and scissors that are used when creating a graphics pipeline object.

Note that the number of viewports and scissors must be the same.

Variants

Fixed

Fields

data: Vec<(Viewport, Scissor)>

State of the viewports and scissors.

The state is known in advance.

FixedViewport

Fields

viewports: Vec<Viewport>

State of the viewports.

scissor_count_dynamic: bool

Sets whether the scissor count is also dynamic, or only the scissors themselves.

If set to true, the device API version must be at least 1.3, or the extended_dynamic_state feature must be enabled on the device.

The state of viewports is known in advance, but the state of scissors is dynamic and will be set when drawing.

FixedScissor

Fields

scissors: Vec<Scissor>

State of the scissors.

viewport_count_dynamic: bool

Sets whether the viewport count is also dynamic, or only the viewports themselves.

If set to true, the device API version must be at least 1.3, or the extended_dynamic_state feature must be enabled on the device.

The state of scissors is known in advance, but the state of viewports is dynamic and will be set when drawing.

Dynamic

Fields

count: u32

Number of viewports and scissors.

This is ignored if both viewport_count_dynamic and scissor_count_dynamic are true.

viewport_count_dynamic: bool

Sets whether the viewport count is also dynamic, or only the viewports themselves.

If set to true, the device API version must be at least 1.3, or the extended_dynamic_state feature must be enabled on the device.

scissor_count_dynamic: bool

Sets whether the scissor count is also dynamic, or only the scissors themselves.

If set to true, the device API version must be at least 1.3, or the extended_dynamic_state feature must be enabled on the device.

The state of both the viewports and scissors is dynamic and will be set when drawing.

Implementations

impl ViewportState

pub fn new() -> Self

Creates a ViewportState with fixed state and no viewports or scissors.

pub fn viewport_fixed_scissor_fixed(
    data: impl IntoIterator<Item = (Viewport, Scissor)>
) -> Self

Creates a ViewportState with fixed state from the given viewports and scissors.

pub fn viewport_fixed_scissor_irrelevant(
    data: impl IntoIterator<Item = Viewport>
) -> Self

Creates a ViewportState with fixed state from the given viewports, and matching scissors that cover the whole viewport.

pub fn viewport_dynamic_scissor_irrelevant() -> Self

Creates a ViewportState with dynamic viewport, and a single scissor that always covers the whole viewport.

pub fn viewport_dynamic_scissor_dynamic(count: u32) -> Self

Creates a ViewportState with dynamic viewports and scissors, but a fixed count.

pub fn viewport_count_dynamic_scissor_count_dynamic() -> Self

Creates a ViewportState with dynamic viewport count and scissor count.

pub fn count(&self) -> Option<u32>

Returns the number of viewports and scissors.

None is returned if both viewport_count_dynamic and scissor_count_dynamic are true.

Trait Implementations

impl Clone for ViewportState

fn clone(&self) -> ViewportState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ViewportState

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

Formats the value using the given formatter.

impl Default for ViewportState

fn default() -> Self

Returns ViewportState::new().