# [−] [src] Struct sfml_rust::vkprocessor::VkProcessor

    pub struct VkProcessor<'a> {
        pub instance: Arc<Instance>,
        pub physical: PhysicalDevice<'a>,
        pub device: Arc<Device>,
        pub queues: QueuesIter,
        pub queue: Arc<Queue>,
        pub swapchain: Option<Arc<Swapchain<Window>>>,
        pub swapchain_images: Option<Vec<Arc<SwapchainImage<Window>>>>,
        // some fields omitted
    }

VKProcessor holds the vulkan instance information, the swapchain, and the compute and canvas states

## Fields

`instance: Arc<Instance>` `physical: PhysicalDevice<'a>` `device: Arc<Device>` `queues: QueuesIter` `queue: Arc<Queue>` `swapchain: Option<Arc<Swapchain<Window>>>` `swapchain_images: Option<Vec<Arc<SwapchainImage<Window>>>>`

## Methods

### `impl<'a> VkProcessor<'a>` [src]

#### `pub fn new(
instance: &'a Arc<Instance>,
surface: &'a Arc<Surface<Window>>
) -> VkProcessor<'a>` [src]

Creates a new VkProcessor from an instance and surface This includes the physical device, queues, compute and canvas state

#### `pub fn is_open(&mut self) -> bool` [src]

VKProcessor controls the window. So it will let the main loop know when it is done

#### `pub fn create_swapchain(&mut self, surface: &'a Arc<Surface<Window>>)` [src]

Using the surface, we calculate the surface capabilities and create the swapchain and swapchain images

#### `pub fn recreate_swapchain(&mut self, surface: &'a Arc<Surface<Window>>)` [src]

On screen resizes, the swapchain and images must be recreated

#### `pub fn preload_textures(&mut self)` [src]

A hardcoded list of textures which can be preloaded from this function

#### `pub fn preload_kernels(&mut self)` [src]

A hardcoded list of kernels which can be preloaded from this function

#### `pub fn preload_shaders(&mut self)` [src]

A hardcoded list of shaders which can be preloaded from this function

#### `pub fn preload_fonts(&mut self)` [src]

A hardcoded list of shaders which can be proloaded from this function

#### `pub fn get_texture_handle(
&self,
texture_name: String
) -> Option<Arc<CanvasTextureHandle>>` [src]

O(n) Lookup for the matching texture string

#### `pub fn get_kernel_handle(
&self,
kernel_name: String
) -> Option<Arc<CompuKernelHandle>>` [src]

O(n) Lookup for the matching kernel string

#### `pub fn get_shader_handle(
&self,
shader_name: String
) -> Option<Arc<CompiledShaderHandle>>` [src]

O(n) Lookup for the matching shader string

#### `pub fn get_font_handle(
&self,
font_name: String
) -> Option<Arc<CanvasFontHandle>>` [src]

#### `pub fn new_swap_image(
&mut self,
dimensions: (u32, u32)
) -> Arc<CanvasImageHandle>` [src]

Create a new image which has the transfer usage

#### `pub fn new_compute_buffer(
&mut self,
data: Vec<u8>,
dimensions: (u32, u32),
stride: u32
) -> Arc<CompuBufferHandle>` [src]

Builds a compute buffer and returns it's handle

#### `pub fn read_compute_buffer(&mut self, handle: Arc<CompuBufferHandle>) -> Vec<u8>` [src]

Takes a compute buffer handle and returns the read data

#### `pub fn write_compute_buffer(
&self,
handle: Arc<CompuBufferHandle>,
data: Vec<u8>
)` [src]

Takes a compute buffer handle and writes the received data

#### `pub fn run(
&mut self,
surface: &'a Arc<Surface<Window>>,
canvas_frame: CanvasFrame,
compute_frame: CompuFrame
)` [src]

Run the VKprocessor for a single frame, consuming the Canvas/Compu Frames

## Auto Trait Implementations

### `impl<'a> !Send for VkProcessor<'a>`

### `impl<'a> Unpin for VkProcessor<'a>`

### `impl<'a> !Sync for VkProcessor<'a>`

### `impl<'a> !UnwindSafe for VkProcessor<'a>`

### `impl<'a> !RefUnwindSafe for VkProcessor<'a>`

## Blanket Implementations

### `impl<T, U> Into<U> for T where
U: From<T>,` [src]

#### `fn into(self) -> U` [src]

Performs the conversion.

### `impl<T> From<T> for T` [src]

#### `fn from(t: T) -> T` [src]

Performs the conversion.

### `impl<T, U> TryFrom<U> for T where
U: Into<T>,` [src]

#### `type Error = Infallible`

The type returned in the event of a conversion error.

#### `fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>` [src]

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

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

The type returned in the event of a conversion error.

#### `fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>` [src]

Performs the conversion.

### `impl<T> BorrowMut<T> for T where
T: ?Sized,` [src]

#### `fn borrow_mut(&mut self) -> &mut T` [src]

Mutably borrows from an owned value. Read more

### `impl<T> Borrow<T> for T where
T: ?Sized,` [src]

#### `fn borrow(&self) -> &T` [src]

Immutably borrows from an owned value. Read more

### `impl<T> Any for T where
T: 'static + ?Sized,` [src]

#### `fn type_id(&self) -> TypeId` [src]

Gets the `TypeId` of `self`. Read more

### `impl<T> SetParameter for T`

#### `fn set<T>(&mut self, value: T) -> <T as Parameter<Self>>::Result where
T: Parameter<Self>,`

Sets `value` as a parameter of `self`.

### `impl<T> Same<T> for T`

#### `type Output = T`

Should always be `Self`

### `impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,`

#### `fn to_subset(&self) -> Option<SS>`

The inverse inclusion map: attempts to construct `self` from the equivalent element of its superset. Read more

#### `fn is_in_subset(&self) -> bool`

Checks if `self` is actually part of its subset `T` (and can be converted to it).

#### `unsafe fn to_subset_unchecked(&self) -> SS`

Use with care! Same as `self.to_subset` but without any property checks. Always succeeds.

#### `fn from_subset(element: &SS) -> SP`

The inclusion map: converts `self` to the equivalent element of its superset.

### `impl<T> Content for T`

#### `fn ref_from_ptr(ptr: *mut c_void, size: usize) -> Option<*mut T>`

Builds a pointer to this type from a raw pointer.

#### `fn is_size_suitable(size: usize) -> bool`

Returns true if the size is suitable to store a type like this.

#### `fn indiv_size() -> usize`

Returns the size of an individual element.

### `impl<T> Erased for T`

### `impl<T> SafeBorrow<T> for T`

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g., `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g., `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g., `str,u8` or `String,struct:Vec,test`)