mxvk_wrap.graphics.Sprite3D Class Reference

Public Member Functions
None	__init__ (self, "App" app, str|Path image, *, str vertex_shader="", str fragment_shader="")
	A billboard sprite rendered through MXVK's 3D command callback.
None	close (self)
None	queue (self, Sequence[float] position, Sequence[float] size, Sequence[float] color=(1.0, 1.0, 1.0, 1.0), float rotation=0.0)

Public Attributes
	native = None
	Load a 3D sprite owned by app.

Detailed Description

Definition at line 130 of file graphics.py.

Constructor & Destructor Documentation

__init__()

None mxvk_wrap.graphics.Sprite3D.__init__	(		self,
		"App"	app,
		str | Path	image,
		*	,
		str	vertex_shader = "",
		str	fragment_shader = "" )

A billboard sprite rendered through MXVK's 3D command callback.

Definition at line 133 of file graphics.py.

    def __init__(self, app: "App", image: str | Path, *, vertex_shader: str = "", fragment_shader: str = "") -> None:
        ## @brief Load a 3D sprite owned by @p app.
        self.native = None
        try:
            self.native = app.create_sprite3d(str(image), vertex_shader, fragment_shader)
        except Exception:
            _abort_failed_resource(app)
            raise
        app.add(self)
 

Member Function Documentation

close()

None mxvk_wrap.graphics.Sprite3D.close

(

self

)

Definition at line 147 of file graphics.py.

    def close(self) -> None:
        ## @brief Release 3D sprite resources and drop its native handle.
        if self.native is not None:
            self.native.cleanup()
            self.native = None
 
 

queue()

None mxvk_wrap.graphics.Sprite3D.queue	(		self,
		Sequence[float]	position,
		Sequence[float]	size,
		Sequence[float]	color = (1.0, 1.0, 1.0, 1.0),
		float	rotation = 0.0 )

Definition at line 143 of file graphics.py.

    def queue(self, position: Sequence[float], size: Sequence[float], color: Sequence[float] = (1.0, 1.0, 1.0, 1.0), rotation: float = 0.0) -> None:
        ## @brief Queue one billboard draw.
        self.native.draw(tuple(position), tuple(size), tuple(color), rotation)
 

Member Data Documentation

native

mxvk_wrap.graphics.Sprite3D.native = None

Load a 3D sprite owned by app.

Definition at line 135 of file graphics.py.

---

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

• python-examples/mxvk_wrap/graphics.py