mxvk_wrap.graphics.Sprite Class Reference

Public Member Functions
None	__init__ (self, "App" app, str|Path|None image=None, *, int width=0, int height=0, str vertex_shader="", str fragment_shader="")
	A 2D image that can be queued for drawing each frame.
None	close (self)
None	draw (self, int x=0, int y=0, *, int|None width=None, int|None height=None, float scale=1.0, float rotation=0.0)
None	enable_extended_uniforms (self)
None	set_mouse (self, float x, float y, bool pressed=False)
None	set_uniform (self, int index, float x, float y, float z, float w)
None	shader_params (self, float first=0.0, float second=0.0, float third=0.0, float fourth=0.0)
None	update (self, object pixels, int width, int height, *, int pitch=0)

Public Attributes
	native = None
	Create an image sprite or an empty dynamic texture.

Detailed Description

Definition at line 45 of file graphics.py.

Constructor & Destructor Documentation

__init__()

None mxvk_wrap.graphics.Sprite.__init__	(		self,
		"App"	app,
		str | Path | None	image = None,
		*	,
		int	width = 0,
		int	height = 0,
		str	vertex_shader = "",
		str	fragment_shader = "" )

A 2D image that can be queued for drawing each frame.

Definition at line 48 of file graphics.py.

    def __init__(self, app: "App", image: str | Path | None = None, *, width: int = 0, height: int = 0, vertex_shader: str = "", fragment_shader: str = "") -> None:
        ## @brief Create an image sprite or an empty dynamic texture.
        ## @param app The owning application.
        ## @param image Image file to load; omit for an empty sprite.
        ## @param width Empty texture width.
        ## @param height Empty texture height.
        ## @param vertex_shader Optional vertex SPIR-V path.
        ## @param fragment_shader Optional fragment SPIR-V path.
        self.native = None
        try:
            if image is not None:
                self.native = app.create_sprite(str(image), vertex_shader, fragment_shader)
            elif width > 0 and height > 0:
                self.native = app.create_sprite(width, height, vertex_shader, fragment_shader)
            else:
                raise ValueError("provide image or positive width and height")
        except Exception:
            self.native = None
            _abort_failed_resource(app)
            raise
        app.add(self)
 

Member Function Documentation

close()

None mxvk_wrap.graphics.Sprite.close

(

self

)

Definition at line 123 of file graphics.py.

    def close(self) -> None:
        ## @brief Drop this sprite's native handle before its app is released.
        ## @details MXVK owns sprites through the window; releasing this Python
        ## handle first prevents a Python/native reference cycle at shutdown.
        self.native = None
 
 

draw()

None mxvk_wrap.graphics.Sprite.draw	(		self,
		int	x = 0,
		int	y = 0,
		*	,
		int | None	width = None,
		int | None	height = None,
		float	scale = 1.0,
		float	rotation = 0.0 )

Definition at line 70 of file graphics.py.

    def draw(self, x: int = 0, y: int = 0, *, width: int | None = None, height: int | None = None, scale: float = 1.0, rotation: float = 0.0) -> None:
        ## @brief Queue this sprite for the current frame.
        ## @param x Left pixel coordinate.
        ## @param y Top pixel coordinate.
        ## @param width Optional output width; requires @p height too.
        ## @param height Optional output height; requires @p width too.
        ## @param scale Uniform scale used when no output rectangle is supplied.
        ## @param rotation Rotation in radians used when no output rectangle is supplied.
        if width is not None or height is not None:
            if width is None or height is None:
                raise ValueError("width and height must be supplied together")
            self.native.draw_rect(x, y, width, height)
        elif rotation != 0.0:
            self.native.draw_rotated(x, y, scale, scale, rotation)
        elif scale != 1.0:
            self.native.draw(x, y, scale, scale)
        else:
            self.native.draw(x, y)
 

enable_extended_uniforms()

None mxvk_wrap.graphics.Sprite.enable_extended_uniforms

(

self

)

Definition at line 101 of file graphics.py.

    def enable_extended_uniforms(self) -> None:
        ## @brief Enable mouse and four-vector uniforms for a custom sprite shader.
        self.native.enable_extended_ubo()
 

set_mouse()

None mxvk_wrap.graphics.Sprite.set_mouse	(		self,
		float	x,
		float	y,
		bool	pressed = False )

Definition at line 105 of file graphics.py.

    def set_mouse(self, x: float, y: float, pressed: bool = False) -> None:
        ## @brief Set mouse data consumed by an extended sprite shader.
        ## @param x Mouse X coordinate in window pixels.
        ## @param y Mouse Y coordinate in window pixels.
        ## @param pressed Whether a mouse button is currently pressed.
        self.native.set_mouse_state(x, y, 1.0 if pressed else 0.0)
 

set_uniform()

None mxvk_wrap.graphics.Sprite.set_uniform	(		self,
		int	index,
		float	x,
		float	y,
		float	z,
		float	w )

Definition at line 112 of file graphics.py.

    def set_uniform(self, index: int, x: float, y: float, z: float, w: float) -> None:
        ## @brief Set one of four generic vectors for an extended sprite shader.
        ## @param index Vector index from zero through three.
        ## @param x First component.
        ## @param y Second component.
        ## @param z Third component.
        ## @param w Fourth component.
        if index not in range(4):
            raise ValueError("uniform index must be from 0 through 3")
        getattr(self.native, f"set_uniform{index}")(x, y, z, w)
 

shader_params()

None mxvk_wrap.graphics.Sprite.shader_params	(		self,
		float	first = 0.0,
		float	second = 0.0,
		float	third = 0.0,
		float	fourth = 0.0 )

Definition at line 97 of file graphics.py.

    def shader_params(self, first: float = 0.0, second: float = 0.0, third: float = 0.0, fourth: float = 0.0) -> None:
        ## @brief Set the four generic shader parameters for this sprite.
        self.native.set_shader_params(first, second, third, fourth)
 

update()

None mxvk_wrap.graphics.Sprite.update	(		self,
		object	pixels,
		int	width,
		int	height,
		*	,
		int	pitch = 0 )

Definition at line 89 of file graphics.py.

    def update(self, pixels: object, width: int, height: int, *, pitch: int = 0) -> None:
        ## @brief Replace this sprite's pixels with a contiguous RGBA8 array.
        ## @param pixels NumPy-compatible RGBA8 pixel array.
        ## @param width Pixel width.
        ## @param height Pixel height.
        ## @param pitch Bytes per row; zero uses @c width * 4.
        self.native.update_texture(pixels, width, height, pitch)
 

Member Data Documentation

native

mxvk_wrap.graphics.Sprite.native = None

Create an image sprite or an empty dynamic texture.

Set one of four generic vectors for an extended sprite shader.

Parameters

app	The owning application.
image	Image file to load; omit for an empty sprite.
width	Empty texture width.
height	Empty texture height.
vertex_shader	Optional vertex SPIR-V path.
fragment_shader	Optional fragment SPIR-V path.
index	Vector index from zero through three.
x	First component.
y	Second component.
z	Third component.
w	Fourth component.

Definition at line 56 of file graphics.py.

---

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

• python-examples/mxvk_wrap/graphics.py