Struct Engine

Source
pub struct Engine<'q, NL: NativeLinker> { /* private fields */ }

Implementations§

Source§

impl<'q, PL: NativeLinker> Engine<'q, PL>

Source

pub fn new( name: &str, version: Version, native_link: PL, requested_features: VkPhysicalDeviceFeatures, engine_events_bus: (Sender<EngineEvent>, Receiver<EngineEvent>), frame_timing_receiver: Receiver<()>, shared_event_queue: &'q EventQueue, ) -> Self

Source

pub fn post_init(&mut self)

Source§

impl<'q, NL: NativeLinker> Engine<'q, NL>

Source

pub fn event_receivers(&self) -> &mut EngineEventReceiver

Source

pub fn next_event(&self) -> impl Future<Output = Event> + 'q

Source

pub async fn quit(&self)

Source

pub const fn graphics(&self) -> &Graphics

Source

pub fn graphics_mut(&mut self) -> &mut Graphics

Source

pub const fn graphics_device(&self) -> &VulkanGfx

Source

pub const fn graphics_queue_family_index(&self) -> u32

Source

pub const fn transfer_queue_family_index(&self) -> u32

Source

pub fn back_buffer_format(&self) -> VkFormat

Source

pub fn back_buffer_size(&self) -> Vector2<u32>

Source

pub fn back_buffer_count(&self) -> usize

Source

pub fn back_buffer(&self, index: usize) -> Option<VkHandleRef<'_, VkImage>>

Source

pub fn iter_back_buffers<'s>( &'s self, ) -> impl Iterator<Item = VkHandleRef<'s, VkImage>> + 's

Source

pub fn requesting_back_buffer_layout(&self) -> (ImageLayout, PipelineStageFlags)

Source

pub fn back_buffer_attachment_desc(&self) -> VkAttachmentDescription

Source

pub fn screen_size(&self) -> Vector2<u32>

Source

pub fn input(&self) -> &InputProcess

Source

pub fn input_mut(&mut self) -> &mut InputProcess

Source

pub fn submit_commands( &mut self, generator: impl for<'a> FnOnce(CmdRecord<'a, VulkanGfx>) -> CmdRecord<'a, VulkanGfx>, ) -> Result<()>

Source

pub fn submit_buffered_commands( &mut self, batches: &[SubmitInfo<'_, '_, '_>], fence: &mut impl VkHandleMut<Handle = VkFence>, ) -> Result<()>

Source

pub const fn audio_mixer(&self) -> &Arc<RwLock<Mixer>>

Source§

impl<PL: NativeLinker> Engine<'_, PL>

Source

pub fn load<A: FromAsset>(&self, path: &str) -> Result<A, A::Error>

Source

pub fn streaming<A: FromStreamingAsset>( &self, path: &str, ) -> Result<A, A::Error>

Source

pub fn rendering_precision(&self) -> f32

Source§

impl<PL: NativeLinker> Engine<'_, PL>

Source

pub fn prepare_frame(&mut self) -> Result<FrameData, PrepareFrameError>

Source

pub fn do_render( &mut self, bb_index: u32, copy_submission: Option<SubmissionBatchBuilder<'_>>, render_submission: SubmissionBatchBuilder<'_>, ) -> Result<()>

Source

pub fn wait_for_last_rendering_completion(&mut self) -> Result<()>

Source

pub fn resize_presenter_backbuffers(&mut self, new_size: Vector2<u32>)

Source

pub fn sound_backend_callback(&self, output_buffer: &mut [f32])

Trait Implementations§

Source§

impl<NL: NativeLinker> Drop for Engine<'_, NL>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl<'q, NL> !Freeze for Engine<'q, NL>

§

impl<'q, NL> !RefUnwindSafe for Engine<'q, NL>

§

impl<'q, NL> !Send for Engine<'q, NL>

§

impl<'q, NL> !Sync for Engine<'q, NL>

§

impl<'q, NL> Unpin for Engine<'q, NL>
where NL: Unpin, <NL as NativeLinker>::Presenter: Unpin,

§

impl<'q, NL> !UnwindSafe for Engine<'q, NL>

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more