Rename default allocator to simple allocator

Author: adrien-ben

CHANGELOG.md

@@ -11,6 +11,7 @@
 - Renderer is now generic over the `Allocator` trait.
 - Remove `dynamic-rendering` feature.
 - Functions that used to take `vk::RenderPass` or `DynamicRendering` now take `RenderMode` instead.
+- `Renderer::with_default_allocator` is now `Renderer::with_simple_allocator`.
 
 ## 0.11.0
 

src/lib.rs

@@ -94,37 +94,37 @@
 //! You can find a example using egui managed and user managed textures [here](./examples/textures.rs).
 //!
 //! ## Allocators
-//! 
+//!
 //! GPU memory allocations are made using allocators. An allocator in any type that implements [`allocator::Allocator`]. You can use one of
 //! the provided allocators or implement your own.
-//! 
+//!
 //! ### Simple allocator
-//! 
-//! Simple allocator using [vkAllocatorMemory][vk-allocate-memory] for each allocation. Created with [`Renderer::with_default_allocator`].
+//!
+//! Simple allocator using [vkAllocatorMemory][vk-allocate-memory] for each allocation. Created with [`Renderer::with_simple_allocator`].
 //! Requires the `simple-allocator` feature.
-//! 
+//!
 //! ### GPU Allocator
-//! 
+//!
 //! Uses [gpu-allocator][gpu-allocator] to handle gpu memory. Created with [`Renderer::with_gpu_allocator`] which takes
 //! a `Arc<Mutex<gpu_allocator::vulkan::Allocator>>`. Requires the `gpu-allocator` feature.
-//! 
+//!
 //! ### VkMem Allocator
-//! 
+//!
 //! Uses [vk-mem-rs][vk-mem-rs] to handle gpu memory. Created with [`Renderer::with_vk_mem_allocator`] which takes
 //! a `Arc<vk_mem::Allocator>`. Requires the `vk-mem` feature.
-//! 
+//!
 //! ### Custom allocator
-//! 
+//!
 //! You can pass your own allocator using [`Renderer::with_custom_allocator`]. Requires the `custom-allocator` feature.
-//! 
+//!
 //! Here is [an example of custom delegating allocator](./examples/common/renderer.rs).
 //!
 //! ## Render mode
 //! 
 //! The renderer supports rendering with a render pass or using dynamic rendering. It is done by passing `RenderMode` when creating the renderer.
 //! 
 //! ## Features
-//! 
+//!
 //! - **simple-allocator** : Allow simple allocator usage.
 //! - **gpu-allocator** : Allow [gpu-allocator][gpu-allocator] allocator usage.
 //! - **vk-mem** : Allow [vk-mem-rs][vk-mem-rs] allocator usage.
@@ -135,8 +135,8 @@
 //! You can find an example of integration with [winit][winit] in the [common module](examples/common/mod.rs) of the examples.
 //!
 //! ```rust
-//! // Example with default allocator
-//! let renderer : Renderer<SimpleAllocator> = Renderer::with_default_allocator(
+//! // Example with simple allocator
+//! let renderer : Renderer<SimpleAllocator> = Renderer::with_simple_allocator(
 //!     &vk_instance,
 //!     vk_physical_device,
 //!     vk_device.clone(),

src/renderer.rs

@@ -88,7 +88,7 @@ pub struct Renderer<A: Allocator> {
 
 #[cfg(feature = "simple-allocator")]
 impl Renderer<allocator::SimpleAllocator> {
-    /// Create a renderer using the default allocator.
+    /// Create a renderer using the simple allocator.
     ///
     /// At initialization all Vulkan resources are initialized. Vertex and index buffers are not created yet.
     ///
@@ -104,7 +104,7 @@ impl Renderer<allocator::SimpleAllocator> {
     ///
     /// * [`RendererError`] - If the number of in flight frame in incorrect.
     /// * [`RendererError`] - If any Vulkan or io error is encountered during initialization.
-    pub fn with_default_allocator(
+    pub fn with_simple_allocator(
         instance: &ash::Instance,
         physical_device: vk::PhysicalDevice,
         device: Device,