BBMOD_DynamicBatch

constructor

new BBMOD_DynamicBatch(_model, _size)

Description

A dynamic batch is a structure that allows you to render multiple instances of a single model at once, each with its own position, scale and rotation. Compared to BBMOD_Model.submit, this drastically reduces draw calls and increases performance, but requires more memory. Current limitations are that the model must not have bones (it cannot be animated) and it can use only a single material. Number of model instances per batch is also affected by maximum number of uniforms that a vertex shader can accept.

Arguments

Name	Type	Description
_model	`Struct.BBMOD_Model`	The model to create a dynamic batch of. Must use a single material and must not have bones.
_size	`Real`	Number of model instances in the batch.

Properties

Name	Description
Model	A model that is being batched.
Size	Number of model instances in the batch.

Methods

Name	Description
default_fn	The default function used in BBMOD_DynamicBatch.render_object. Uses instance's variables `x`, `y`, `z` for position, `image_xscale` for uniform scale and `image_angle` for rotation around the `z` axis.
freeze	Freezes the dynamic batch. This makes it render faster.
render	Enqueues the dynamic batch for rendering.
render_object	Enqueues all instances of an object for rendering in batches of BBMOD_DynamicBatch.size.
submit	Immediately submits the dynamic batch for rendering.
submit_object	Immediately submits all instances of an object for rendering in batches of BBMOD_DynamicBatch.size.

Example

Following code renders all instances of a car object in batches of 64.

/// @desc Create event
modCar = new BBMOD_Model("Car.bbmod");
matCar = new BBMOD_DefaultMaterial(BBMOD_ShDefaultBatched,
    sprite_get_texture(SprCar, 0));
carBatch = new BBMOD_DynamicBatch(modCar, 64);

/// @desc Draw event
carBatch.render_object(OCar, matCar);