Struct InstanceBuilder 

pub struct InstanceBuilder { /* private fields */ }

Implementations

impl InstanceBuilder

pub fn new(window: Option<Arc<dyn WindowTraits>>) -> Self

pub fn app_name(self, app_name: impl Into<String>) -> Self

Set the application name that will be passed to Vulkan via VkApplicationInfo.

pub fn engine_name(self, engine_name: impl Into<String>) -> Self

Set the engine name that will be passed to Vulkan via VkApplicationInfo.

pub fn app_version(self, version: Version) -> Self

Set the application version reported to Vulkan.

pub fn engine_version(self, version: Version) -> Self

Set the engine version reported to Vulkan.

pub fn require_api_version(self, version: Version) -> Self

Require a minimum Vulkan API version for instance creation.

pub fn minimum_instance_version(self, version: Version) -> Self

Set the minimum instance API version that must be supported by the system.

pub fn enable_layer(self, layer: ExtensionName) -> Self

Enable the given instance layer for creation (e.g. validation layers).

pub fn enable_extension(self, extension: ExtensionName) -> Self

Enable the given Vulkan instance extension for creation.

pub fn enable_validation_layers(self, enable: bool) -> Self

Explicitly enable or disable validation layers.

pub fn request_validation_layers(self, request: bool) -> Self

Request validation layers when available on the system (will be used if present).

pub fn use_default_debug_messenger(self) -> Self

Use the default debug messenger which prints messages to stdout.

pub fn use_default_tracing_messenger(self) -> Self

pub fn set_debug_messenger( self, callback: PFN_vkDebugUtilsMessengerCallbackEXT, ) -> Self

Set a custom debug messenger callback function.

pub fn debug_user_data(self, debug_user_data: DebugUserData) -> Self

Provide a user data pointer that will be passed to the debug callback.

pub fn headless(self, headless: bool) -> Self

Indicate that no windowing surface will be created (headless mode).

pub fn debug_messenger_severity( self, severity: DebugUtilsMessageSeverityFlagsEXT, ) -> Self

Set the severity flags for the debug messenger (e.g. WARNING | ERROR).

pub fn add_debug_messenger_severity( self, severity: DebugUtilsMessageSeverityFlagsEXT, ) -> Self

Add additional severity flags to the debug messenger.

pub fn debug_messenger_type( self, message_type: DebugUtilsMessageTypeFlagsEXT, ) -> Self

Set the types of debug messages the messenger should receive (general/validation/perf).

pub fn add_debug_messenger_type( self, message_type: DebugUtilsMessageTypeFlagsEXT, ) -> Self

Add additional debug message types to the messenger configuration.

pub fn build(self) -> Result<Arc<Instance>>

Build and return an Instance according to the configured options.

Performs validation of available layers/extensions and creates the Vulkan instance and optional debug messenger and surface.

Trait Implementations

impl Debug for InstanceBuilder

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

Formats the value using the given formatter.