Skip to content

Commit 8036bfe

Browse files
committed
doc: update some docs for clarity
1 parent ed2e5a6 commit 8036bfe

4 files changed

Lines changed: 7 additions & 5 deletions

File tree

src/graph/physical_resource.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ pub enum PhysicalResource {
2020
/// ```
2121
/// use phobos::prelude::*;
2222
///
23-
/// let resource = VirtualResource::new("image");
23+
/// let resource = VirtualResource::image("image");
2424
/// let image = Image::new(/*...*/);
2525
/// let view = image.view(vk::ImageAspectFlags::COLOR)?;
2626
/// let mut bindings = PhysicalResourceBindings::new();

src/graph/record.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -387,7 +387,7 @@ fn record_node<'q, D: ExecutionDomain, U, A: Allocator>(
387387
impl<'cb, D: ExecutionDomain, U, A: Allocator> RecordGraphToCommandBuffer<D, U, A>
388388
for BuiltPassGraph<'cb, D, U, A>
389389
{
390-
/// Record the rendergraph to the command buffer. This will pass `user_data` along to every pass executor in the graph.
390+
/// Record the render graph to the command buffer. This will pass `user_data` along to every pass executor in the graph.
391391
fn record<'q>(
392392
&mut self,
393393
mut cmd: IncompleteCommandBuffer<'q, D, A>,

src/pipeline/cache.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,8 @@ struct PipelineCacheInner<A: Allocator> {
5050
/// [`PipelineCache::create_named_pipeline`].
5151
///
5252
/// This struct is `Clone`, `Send` and `Sync`.
53+
///
54+
/// This should generally be accessed through a global [`ResourcePool`](crate::pool::ResourcePool)
5355
/// # Example usage
5456
/// ```
5557
/// use phobos::prelude::*;

src/pipeline/mod.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
//! Deals with wrappers for creating and managing Vulkan pipeline objects and their related objects.
22
//!
3-
//! This is a helper that manages creating pipelines, obtaining reflection information from them (if the `shader-reflection` feature is enabled).
3+
//! The pipeline cache is a helper that manages creating pipelines, obtaining reflection information from them (if the `shader-reflection` feature is enabled).
44
//! You probably only want one of these in the entire application. Since it's used everywhere, to ensure safe access
55
//! is possible, the inner state of a [`PipelineCache`](crate::PipelineCache) is wrapped in an `Arc<RwLock<PipelineCacheInner>>`,
6-
//! so this is `Send`, `Sync` and `Clone`.
6+
//! so this is `Send`, `Sync` and `Clone`. An instance of this is included in the [`ResourcePool`](crate::pool::ResourcePool).
77
//!
88
//! # Example
99
//! The following example uses the [`PipelineBuilder`](crate::PipelineBuilder) utility to make a graphics pipeline and add it to the pipeline cache.
@@ -53,8 +53,8 @@
5353
5454
use ash::vk;
5555

56-
use crate::pipeline::raytracing::ShaderBindingTable;
5756
use crate::{Allocator, Device};
57+
use crate::pipeline::raytracing::ShaderBindingTable;
5858

5959
pub mod builder;
6060
pub mod cache;

0 commit comments

Comments
 (0)