mxvk_wrap.app.App Class Reference

Inheritance diagram for mxvk_wrap.app.App:

Public Member Functions
"App"	__enter__ (self)
None	__exit__ (self, *object _)
None	__init__ (self, str title="MXVK", int width=1280, int height=720, *, bool fullscreen=False, bool vsync=True, bool validation=False, str|Path|None shader_directory=None)
	A simple callback-driven MXVK application.
Any	add (self, Any resource)
None	close (self)
None	draw (self)
None	draw_text (self, str text, int x, int y, Any font, Color color=Color(255, 255, 255, 255))
None	event (self, mxvk.Event event)
None	on_event (self, mxvk.Event event)
None	proc (self)
None	quit (self)
None	run (self)
tuple[int, int]|None	text_size (self, str text, Any font)

Protected Attributes
bool	_closed = False
	Safely release managed objects and Vulkan window resources.
list	_managed = []
	Safely release managed objects and Vulkan window resources.

Detailed Description

Definition at line 13 of file app.py.

Constructor & Destructor Documentation

__init__()

None mxvk_wrap.app.App.__init__	(		self,
		str	title = "MXVK",
		int	width = 1280,
		int	height = 720,
		*	,
		bool	fullscreen = False,
		bool	vsync = True,
		bool	validation = False,
		str | Path | None	shader_directory = None )

A simple callback-driven MXVK application.

Subclass this class and override draw and optionally on_event. Managed sprites and models are released before the window.

Definition at line 18 of file app.py.

    def __init__(self, title: str = "MXVK", width: int = 1280, height: int = 720, *, fullscreen: bool = False, vsync: bool = True, validation: bool = False, shader_directory: str | Path | None = None) -> None:
        ## @brief Create a Vulkan window with practical Python defaults.
        ## @param title Text displayed in the window title bar.
        ## @param width Initial window width in pixels.
        ## @param height Initial window height in pixels.
        ## @param fullscreen Start in fullscreen mode when true.
        ## @param vsync Synchronize presentation with the display when true.
        ## @param validation Enable Vulkan validation layers when true.
        ## @param shader_directory Optional directory containing shared shaders.
        if shader_directory is not None:
            mxvk.set_default_shader_directory(str(shader_directory))
        present_mode = mxvk.PresentModePreference.vsync if vsync else mxvk.PresentModePreference.low_latency
        super().__init__(title, width, height, fullscreen, validation, present_mode, mxvk.RuntimeMode.windowed)
        self._managed: list[Any] = []
        self._closed = False
 

Member Function Documentation

__enter__()

"App" mxvk_wrap.app.App.__enter__

(

self

)

Definition at line 103 of file app.py.

    def __enter__(self) -> "App":
        ## @brief Enter a context manager owning this application.
        return self
 

__exit__()

None mxvk_wrap.app.App.__exit__	(		self,
		*object	_ )

Definition at line 107 of file app.py.

    def __exit__(self, *_: object) -> None:
        ## @brief Close the application when its context exits.
        self.close()

add()

Any mxvk_wrap.app.App.add	(		self,
		Any	resource )

Definition at line 52 of file app.py.

    def add(self, resource: Any) -> Any:
        ## @brief Keep a wrapper resource alive for the application's lifetime.
        ## @param resource A wrapper created for this application.
        ## @return The supplied resource, for convenient inline use.
        self._managed.append(resource)
        return resource
 

close()

None mxvk_wrap.app.App.close

(

self

)

Definition at line 88 of file app.py.

    def close(self) -> None:
        ## @brief Safely release managed objects and Vulkan window resources.
        if self._closed:
            return
        self._closed = True
        try:
            self.wait_idle()
            for resource in reversed(self._managed):
                close = getattr(resource, "close", None)
                if close is not None:
                    close()
        finally:
            self._managed.clear()
            self.release()
 

draw()

None mxvk_wrap.app.App.draw

(

self

)

Definition at line 34 of file app.py.

    def draw(self) -> None:
        ## @brief Draw one frame.
        ## @details Override this method; queue sprite drawing here.
        pass
 

draw_text()

None mxvk_wrap.app.App.draw_text	(		self,
		str	text,
		int	x,
		int	y,
		Any	font,
		Color	color = Color(255, 255, 255, 255) )

Definition at line 59 of file app.py.

    def draw_text(self, text: str, x: int, y: int, font: Any, color: Color = Color(255, 255, 255, 255)) -> None:
        ## @brief Queue text using a supplied font without changing the default font.
        ## @param text Text to draw.
        ## @param x Left pixel coordinate.
        ## @param y Top pixel coordinate.
        ## @param font A wrapper @c Font created from a font file and size.
        ## @param color RGBA text color.
        ## @details This calls MXVK's per-draw font overload and does not call
        ## @c set_font, so existing default-font text remains unchanged.
        self.print_text(text, x, y, color, font.native)
 

event()

None mxvk_wrap.app.App.event	(		self,
		mxvk.Event	event )

Definition at line 48 of file app.py.

    def event(self, event: mxvk.Event) -> None:
        ## @brief Native event-loop callback that forwards to @c on_event.
        self.on_event(event)
 

on_event()

None mxvk_wrap.app.App.on_event	(		self,
		mxvk.Event	event )

Definition at line 39 of file app.py.

    def on_event(self, event: mxvk.Event) -> None:
        ## @brief Receive one SDL input event.
        ## @param event Read-only MXVK event data.
        pass
 

proc()

None mxvk_wrap.app.App.proc

(

self

)

Definition at line 44 of file app.py.

    def proc(self) -> None:
        ## @brief Native render-loop callback that forwards to @c draw.
        self.draw()
 

quit()

None mxvk_wrap.app.App.quit

(

self

)

Definition at line 84 of file app.py.

    def quit(self) -> None:
        ## @brief Request that the render loop exit after the current frame.
        self.request_exit()
 

run()

None mxvk_wrap.app.App.run

(

self

)

Definition at line 77 of file app.py.

    def run(self) -> None:
        ## @brief Run until @c quit is called or the window is closed.
        try:
            self.loop()
        finally:
            self.close()
 

text_size()

tuple[int, int] | None mxvk_wrap.app.App.text_size	(		self,
		str	text,
		Any	font )

Definition at line 70 of file app.py.

    def text_size(self, text: str, font: Any) -> tuple[int, int] | None:
        ## @brief Measure text using a supplied font without changing the default font.
        ## @param text Text to measure.
        ## @param font A wrapper @c Font created from a font file and size.
        ## @return Width and height in pixels, or @c None when measurement fails.
        return self.get_text_dimensions(text, font.native)
 

Member Data Documentation

_closed

bool mxvk_wrap.app.App._closed = False

protected

Safely release managed objects and Vulkan window resources.

Definition at line 32 of file app.py.

_managed

mxvk_wrap.app.App._managed = []

protected

Safely release managed objects and Vulkan window resources.

Definition at line 31 of file app.py.

---

The documentation for this class was generated from the following file:

• python-examples/mxvk_wrap/app.py