mxvk_wrap.graphics.Model Class Reference

Public Member Functions
None	__init__ (self, "App" app, str|Path path, *, str|Path textures="", str|Path texture_directory="", float scale=1.0)
	A loadable 3D model with one-call setup.
None	cleanup (self, "App" app)
None	close (self)
None	shaders (self, "App" app, str|Path vertex, str|Path fragment)

Public Attributes
	native = None
	Explicitly free model GPU resources before closing app.

Protected Attributes
	_app = app
	Load a model and retain its application lifetime.

Detailed Description

Definition at line 154 of file graphics.py.

Constructor & Destructor Documentation

__init__()

None mxvk_wrap.graphics.Model.__init__	(		self,
		"App"	app,
		str | Path	path,
		*	,
		str | Path	textures = "",
		str | Path	texture_directory = "",
		float	scale = 1.0 )

A loadable 3D model with one-call setup.

Definition at line 157 of file graphics.py.

    def __init__(self, app: "App", path: str | Path, *, textures: str | Path = "", texture_directory: str | Path = "", scale: float = 1.0) -> None:
        ## @brief Load a model and retain its application lifetime.
        self._app = app
        self.native = None
        try:
            self.native = mxvk.AbstractModel()
            self.native.load(app, str(path), str(textures), str(texture_directory), scale)
        except Exception:
            self.native = None
            _abort_failed_resource(app)
            raise
        app.add(self)
 

Member Function Documentation

cleanup()

None mxvk_wrap.graphics.Model.cleanup	(		self,
		"App"	app )

Definition at line 174 of file graphics.py.

    def cleanup(self, app: "App") -> None:
        ## @brief Explicitly free model GPU resources before closing @p app.
        if self.native is not None:
            self.native.cleanup(app)
            self.native = None
 

close()

None mxvk_wrap.graphics.Model.close

(

self

)

Definition at line 180 of file graphics.py.

    def close(self) -> None:
        ## @brief Free model GPU resources and drop its native handle.
        if self.native is not None:
            self.native.cleanup(self._app)
            self.native = None
 
 

shaders()

None mxvk_wrap.graphics.Model.shaders	(		self,
		"App"	app,
		str | Path	vertex,
		str | Path	fragment )

Definition at line 170 of file graphics.py.

    def shaders(self, app: "App", vertex: str | Path, fragment: str | Path) -> None:
        ## @brief Select custom model shaders.
        self.native.set_shaders(app, str(vertex), str(fragment))
 

Member Data Documentation

_app

mxvk_wrap.graphics.Model._app = app

protected

Load a model and retain its application lifetime.

Free model GPU resources and drop its native handle.

Definition at line 159 of file graphics.py.

native

mxvk_wrap.graphics.Model.native = None

Explicitly free model GPU resources before closing app.

Definition at line 160 of file graphics.py.

---

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

• python-examples/mxvk_wrap/graphics.py