Struct GraphicsPipeline

Source
pub struct GraphicsPipeline { /* private fields */ }
Expand description

Defines how the implementation should perform a draw operation.

This object contains the shaders and the various fixed states that describe how the implementation should perform the various operations needed by a draw command.

Implementations§

Source§

impl GraphicsPipeline

Source

pub fn new( device: Arc<Device>, cache: Option<Arc<PipelineCache>>, create_info: GraphicsPipelineCreateInfo, ) -> Result<Arc<Self>, Validated<VulkanError>>

Creates a new GraphicsPipeline.

Source

pub unsafe fn from_handle( device: Arc<Device>, handle: Pipeline, create_info: GraphicsPipelineCreateInfo, ) -> Arc<Self>

Creates a new GraphicsPipeline from a raw object handle.

§Safety
  • handle must be a valid Vulkan object handle created from device.
  • create_info must match the info used to create the object.
Source

pub fn device(&self) -> &Arc<Device>

Returns the device used to create this pipeline.

Source

pub fn flags(&self) -> PipelineCreateFlags

Returns the flags that the pipeline was created with.

Source

pub fn shader_stages(&self) -> ShaderStages

Returns the shader stages that this pipeline contains.

Source

pub fn vertex_input_state(&self) -> Option<&VertexInputState>

Returns the vertex input state used to create this pipeline.

Source

pub fn input_assembly_state(&self) -> Option<&InputAssemblyState>

Returns the input assembly state used to create this pipeline.

Source

pub fn tessellation_state(&self) -> Option<&TessellationState>

Returns the tessellation state used to create this pipeline.

Source

pub fn viewport_state(&self) -> Option<&ViewportState>

Returns the viewport state used to create this pipeline.

Source

pub fn rasterization_state(&self) -> &RasterizationState

Returns the rasterization state used to create this pipeline.

Source

pub fn multisample_state(&self) -> Option<&MultisampleState>

Returns the multisample state used to create this pipeline.

Source

pub fn depth_stencil_state(&self) -> Option<&DepthStencilState>

Returns the depth/stencil state used to create this pipeline.

Source

pub fn color_blend_state(&self) -> Option<&ColorBlendState>

Returns the color blend state used to create this pipeline.

Source

pub fn subpass(&self) -> &PipelineSubpassType

Returns the subpass this graphics pipeline is rendering to.

Source

pub fn dynamic_state(&self) -> &HashSet<DynamicState>

Returns the dynamic states of the pipeline.

Source

pub fn discard_rectangle_state(&self) -> Option<&DiscardRectangleState>

Returns the discard rectangle state used to create this pipeline.

Source

pub fn fragment_shading_rate_state(&self) -> Option<&FragmentShadingRateState>

Returns the fragment shading rate state used to create this pipeline.

Source

pub fn fragment_tests_stages(&self) -> Option<FragmentTestsStages>

If the pipeline has a fragment shader, returns the fragment tests stages used.

Trait Implementations§

Source§

impl Debug for GraphicsPipeline

Source§

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

Formats the value using the given formatter. Read more
Source§

impl DeviceOwned for GraphicsPipeline

Source§

fn device(&self) -> &Arc<Device>

Returns the device that owns self.
Source§

impl Drop for GraphicsPipeline

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl Hash for GraphicsPipeline

Source§

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for GraphicsPipeline

Source§

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Pipeline for GraphicsPipeline

Source§

fn bind_point(&self) -> PipelineBindPoint

Returns the bind point of this pipeline.
Source§

fn layout(&self) -> &Arc<PipelineLayout>

Returns the pipeline layout used in this pipeline.
Source§

fn num_used_descriptor_sets(&self) -> u32

Returns the number of descriptor sets actually accessed by this pipeline. This may be less than the number of sets in the pipeline layout.
Source§

fn descriptor_binding_requirements( &self, ) -> &HashMap<(u32, u32), DescriptorBindingRequirements>

Returns a reference to the descriptor binding requirements for this pipeline.
Source§

impl VulkanObject for GraphicsPipeline

Source§

type Handle = Pipeline

The type of the object.
Source§

fn handle(&self) -> Self::Handle

Returns the raw Vulkan handle of the object.
Source§

impl Eq for GraphicsPipeline

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> DeviceOwnedVulkanObject for T

Source§

fn set_debug_utils_object_name( &self, object_name: Option<&str>, ) -> Result<(), VulkanError>

Assigns a human-readable name to the object for debugging purposes. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.