Raytracer:add

Adds a Mesh or Model to the Raytracer.

The object has a custom transform, and exists on up to 8 layers, given as a bitmask.

After adding all objects to the Raytracer, call Raytracer:build to finalize the raytracer.

id = Raytracer:add(mesh, x, y, z, scale, angle, ax, ay, az, layers, tag)
id = Raytracer:add(model, x, y, z, scale, angle, ax, ay, az, layers, tag)
id = Raytracer:add(mesh, position, scale3, orientation, layers, tag)
id = Raytracer:add(model, position, scale3, orientation, layers, tag)
id = Raytracer:add(mesh, transform, layers, tag)
id = Raytracer:add(model, transform, layers, tag)

Arguments

Name	Type	Default	Description
mesh	Mesh		The Mesh to add to the Raytracer.
x	number	0	The x coordinate to place the object at.
y	number	0	The y coordinate to place the object at.
z	number	0	The z coordinate to place the object at.
scale	number	1	The scale of the object.
angle	number	0	The rotation of the object around its rotation axis, in radians.
ax	number	0	The x component of the axis of rotation.
ay	number	1	The y component of the axis of rotation.
az	number	0	The z component of the axis of rotation.
layers	number	0xff	A binary bitmask of 8 layers to place the object on. The object is placed on all layers by default. For example, 0x1 will place the object on the first layer, 0x2 will place it on the second layer, 0x3 for the first two layers, etc.
tag	number	nil	A custom tag for the object, provided in the shader when the object is hit. Shaders can use this tag for whatever they want. If nil, the tag will be set to the same ID as the one returned by this function. The tag can be between 0 and 16,777,215.

Returns

Name	Type	Description
id	number	An ID for the object. Use it to move the object layer using `Raytracer:set`. If the Raytracer is full, the object is not added and this ID will be nil.

Arguments

Name	Type	Default	Description
model	Model		The Model to add to the Raytracer.
x	number	0	The x coordinate to place the object at.
y	number	0	The y coordinate to place the object at.
z	number	0	The z coordinate to place the object at.
scale	number	1	The scale of the object.
angle	number	0	The rotation of the object around its rotation axis, in radians.
ax	number	0	The x component of the axis of rotation.
ay	number	1	The y component of the axis of rotation.
az	number	0	The z component of the axis of rotation.
layers	number	0xff	A binary bitmask of 8 layers to place the object on. The object is placed on all layers by default. For example, 0x1 will place the object on the first layer, 0x2 will place it on the second layer, 0x3 for the first two layers, etc.
tag	number	nil	A custom tag for the object, provided in the shader when the object is hit. Shaders can use this tag for whatever they want. If nil, the tag will be set to the same ID as the one returned by this function. The tag can be between 0 and 16,777,215.

Returns

Name	Type	Description
id	number	An ID for the object. Use it to move the object layer using `Raytracer:set`. If the Raytracer is full, the object is not added and this ID will be nil.

Arguments

Name	Type	Default	Description
mesh	Mesh		The Mesh to add to the Raytracer.
position	vector		The position to place the object at.
scale3	vector		The scale of the object.
orientation	quaternion		The orientation of the object.
layers	number	0xff	A binary bitmask of 8 layers to place the object on. The object is placed on all layers by default. For example, 0x1 will place the object on the first layer, 0x2 will place it on the second layer, 0x3 for the first two layers, etc.
tag	number	nil	A custom tag for the object, provided in the shader when the object is hit. Shaders can use this tag for whatever they want. If nil, the tag will be set to the same ID as the one returned by this function. The tag can be between 0 and 16,777,215.

Returns

Name	Type	Description
id	number	An ID for the object. Use it to move the object layer using `Raytracer:set`. If the Raytracer is full, the object is not added and this ID will be nil.

Arguments

Name	Type	Default	Description
model	Model		The Model to add to the Raytracer.
position	vector		The position to place the object at.
scale3	vector		The scale of the object.
orientation	quaternion		The orientation of the object.
layers	number	0xff	A binary bitmask of 8 layers to place the object on. The object is placed on all layers by default. For example, 0x1 will place the object on the first layer, 0x2 will place it on the second layer, 0x3 for the first two layers, etc.
tag	number	nil	A custom tag for the object, provided in the shader when the object is hit. Shaders can use this tag for whatever they want. If nil, the tag will be set to the same ID as the one returned by this function. The tag can be between 0 and 16,777,215.

Returns

Name	Type	Description
id	number	An ID for the object. Use it to move the object layer using `Raytracer:set`. If the Raytracer is full, the object is not added and this ID will be nil.

Arguments

Name	Type	Default	Description
mesh	Mesh		The Mesh to add to the Raytracer.
transform	Mat4		The transform of the object.
layers	number	0xff	A binary bitmask of 8 layers to place the object on. The object is placed on all layers by default. For example, 0x1 will place the object on the first layer, 0x2 will place it on the second layer, 0x3 for the first two layers, etc.
tag	number	nil	A custom tag for the object, provided in the shader when the object is hit. Shaders can use this tag for whatever they want. If nil, the tag will be set to the same ID as the one returned by this function. The tag can be between 0 and 16,777,215.

Returns

Name	Type	Description
id	number	An ID for the object. Use it to move the object layer using `Raytracer:set`. If the Raytracer is full, the object is not added and this ID will be nil.

Arguments

Name	Type	Default	Description
model	Model		The Model to add to the Raytracer.
transform	Mat4		The transform of the object.
layers	number	0xff	A binary bitmask of 8 layers to place the object on. The object is placed on all layers by default. For example, 0x1 will place the object on the first layer, 0x2 will place it on the second layer, 0x3 for the first two layers, etc.
tag	number	nil	A custom tag for the object, provided in the shader when the object is hit. Shaders can use this tag for whatever they want. If nil, the tag will be set to the same ID as the one returned by this function. The tag can be between 0 and 16,777,215.

Returns

Name	Type	Description
id	number	An ID for the object. Use it to move the object layer using `Raytracer:set`. If the Raytracer is full, the object is not added and this ID will be nil.

Guides

Examples

Modules

Objects

Callbacks

Functions

Types

Raytracer:add

Arguments

Returns

Arguments

Returns

Arguments

Returns

Arguments

Returns

Arguments

Returns

Arguments

Returns

See also