Openb3d.Openb3dcore:

OpenB3D core functions

Core 3D functions and extra functions not in Blitz3D.

Functions Summary

ActFadeTo	Fades entity to the given alpha value (0..1) at the speed of rate.
ActMoveBy	Moves entity by an x y z position increment at the speed of rate.
ActMoveTo	Moves entity to the given x y z position at the speed of rate.
ActNewtonian	Translates entity in the direction it is moving, rate should be below 1.
ActScaleTo	Scales entity to the given x y z dimensions at the speed of rate.
ActTintTo	Tints entity to the given r g b value (0..255) at the speed of rate.
ActTrackByDistance	Tracks target entity up to a given distance at the speed of rate.
ActTrackByPoint	Tracks target entity at a given point from the entity at the speed of rate.
ActTurnBy	Turns entity by an x y z rotation increment at the speed of rate.
ActTurnTo	Turns entity to the given x y z rotation at the speed of rate.
ActVector	Positions entity according the given x y z vector.
AddAnimSeq	Creates an animation sequence for an entity.
AddMesh	Adds the source mesh to the destination mesh.
AddRenderTarget	undocumented.
AddSurface	Add an existing surface to a mesh.
AddTriangle	Adds a triangle to a surface and returns the triangle's index number.
AddVertex	Adds a vertex to the specified surface and returns the vertices' index number.
AlignToVector	Aligns an entity axis to a vector.
AlphaDiscard	Set discard value (as 0..1) above which to ignore pixel's alpha value, default is 1 (only if flag 2)
AmbientLight	Sets the ambient lighting colour.
AmbientShader	Set default shader for surfaces.
Animate	Animates an entity.
Animating	Returns true if the specified entity is currently animating.
AnimLength	Returns the length of the specified entity's current animation sequence.
AnimSeq	Returns the specified entity's current animation sequence.
AnimTime	Returns the current animation time of an entity.
AntiAlias	Enables or disables fullscreen antialiasing.
AppendAction	Adds action to the end of another one, where act1 happens before act2.
AttachFragShader	Attaches a fragment shader object to a program object, attach vertex first or older compilers will crash.
AttachVertShader	Attaches a vertex shader object to a program object.
BackBufferToTex	Copy the contents of the backbuffer to a texture.
BeginMax2D	Old begin function as in Minib3d is 0, new begin function is 1 (default)
BrushAlpha	Sets the alpha level of a brush.
BrushBlend	Sets the blending mode for a brush.
BrushColor	Sets the colour of a brush.
BrushFX	Sets miscellaneous effects for a brush.
BrushGLBlendFunc	GL equivalent, experimental.
BrushGLColor	GL equivalent, experimental.
BrushShininess	Sets the specular shininess of a brush.
BrushTexture	Assigns a texture to a brush.
BufferToTex	Copy pixmap buffer to texture, buffer must be a byte ptr.
CameraClsColor	Sets camera background color.
CameraClsMode	Sets camera clear mode.
CameraFogColor	Sets camera fog color.
CameraFogMode	Sets the camera fog mode.
CameraFogRange	Sets camera fog range.
CameraPick	Picks the entity positioned at the specified viewport coordinates.
CameraProject	Projects the world coordinates x.
CameraProjMatrix	undocumented.
CameraProjMode	Sets the camera projection mode.
CameraRange	Sets camera range.
CameraToTex	Copy rendered camera view to texture.
CameraViewport	Sets the camera viewport position and size.
CameraZoom	Sets zoom factor for a camera.
CheckFramebufferStatus	Check for framebuffer errors.
ClearCollisions	Clears the collision information list.
ClearSurface	Removes all vertices and/or triangles from a surface.
ClearTextureFilters	Clears the current texture filter list.
ClearWorld	Clears all entities.
CollisionEntity	Returns the other entity involved in a particular collision.
CollisionNX	Returns the x component of the normal of a particular collision.
CollisionNY	Returns the y component of the normal of a particular collision.
CollisionNZ	Returns the z component of the normal of a particular collision.
Collisions	Enables collisions between two different entity types.
CollisionSurface	Returns the handle of the surface belonging to the specified entity that was closest to the point of a particular collision.
CollisionTime	Returns the time taken to calculate a particular collision.
CollisionTriangle	Returns the index number of the triangle belonging to the specified entity that was closest to the point of a particular collision.
CollisionX	Returns the world x coordinate of a particular collision.
CollisionY	Returns the world y coordinate of a particular collision.
CollisionZ	Returns the world z coordinate of a particular collision.
CopyBrush	Returns a copy of the new brush.
CopyEntity	Creates a copy of an entity and returns the handle of the newly created copy.
CopyList	Copy a list or vector. To copy a field list use as a method.
CopyMesh	Creates a copy of a mesh and returns the newly-created mesh's handle.
CopyRect	Copy rectangle of source pixmap pixels to destination, not exactly like B3D.
CopySurface	Returns a copy of the new surface.
CopyTexture	Returns a copy of the new texture.
CountChildren	Returns the number of children of an entity.
CountCollisions	Returns how many collisions an entity was involved in during the last UpdateWorld.
CountMipmaps	Returns the number of mipmaps a texture has.
CountSurfaces	Returns the number of surfaces in a mesh.
CountTriangles	Returns the number of triangles in a surface.
CountVertices	Returns the number of vertices in a surface.
CreateBlob	Create blob from a fluid mesh where radius is the size of the blob.
CreateBone	Create bone.
CreateBrush	Creates a brush and returns a brush handle.
CreateCamera	Creates a camera entity and returns its handle.
CreateCone	Creates a cone mesh/entity and returns its handle.
CreateConstraint	Create constraint force between two entities of given length, doesn't affect rotation.
CreateCube	Creates a cube mesh/entity and returns its handle.
CreateCylinder	Creates a cylinder mesh/entity and returns its handle.
CreateFluid	Create fluid mesh for blobs to use.
CreateFragShader	Returns a new frag shader object from file.
CreateFragShaderString	Returns a new frag shader object from string.
CreateGeosphere	Create geodesic sphere and set terrain size.
CreateLight	Creates a light.
CreateMesh	Create a 'blank' mesh entity and returns its handle.
CreateOcTree	Create octree and set its width, height and depth.
CreateParticleEmitter	Create particle emitter and set sprite for it to use.
CreatePivot	Creates a pivot entity.
CreatePlane	Creates a plane entity and returns its handle.
CreatePostFX	undocumented.
CreateQuad	Create flat quad.
CreateRigidBody	Create rigid physics body attached to four entities.
CreateShader	Load shader from two strings, vertex and fragment.
CreateShaderMaterial	Returns a new shader material without creating any shader objects.
CreateShaderVGF	Load shader from three strings, vertex, geometry and fragment.
CreateShadow	Create stencil shadow, static is for static or dynamic shadows.
CreateSphere	Creates a sphere mesh/entity and returns its handle.
CreateSprite	Creates a sprite entity and returns its handle.
CreateStencil	Create stencil object.
CreateSurface	Creates a surface attached to a mesh and returns the surface's handle.
CreateTerrain	Creates a terrain entity and returns its handle.
CreateTexture	Creates a texture and returns its handle.
CreateVertShader	Returns a new vert shader object from file.
CreateVertShaderString	Returns a new vert shader object from string.
CreateVoxelSprite	Create voxel sprite where slices is the number of sprites.
DeleteFragShader	Deletes a frag shader object from a program object.
DeleteVertShader	Deletes a vert shader object from a program object.
DeltaPitch	Returns the pitch angle.
DeltaYaw	Returns the yaw angle.
DepthBufferToTex	Copy the contents of the depth buffer to a texture.
EmitterParticleAlpha	Set particles alpha at start and end, range is 0..1.
EmitterParticleColor	Set particles RGB color at start and end, default is 255,255,255.
EmitterParticleFunction	Points to callback function for emitter.
EmitterParticleLife	Set particles start, end and random lifespan.
EmitterParticleRotate	Set particles rotation angle at start and end.
EmitterParticleScale	Set particles scale at start and end, default is 1.
EmitterParticleSpeed	Set particles start and end speed.
EmitterRate	Rate between each emission, range is 0.01..1.01.
EmitterVariance	Set random variance of particles, range is 0.001..0.1.
EmitterVector	Set emitters start and end 3d vectors.
EndAction	Ends action so it can be freed, 1 = automatically ended, 2 = manually ended.
EndMax2D	Old end function as in Minib3d is 0, new end function is 1 (default)
EntityAlpha	Sets the entity alpha level of an entity.
EntityBlend	Sets the blending mode of an entity.
EntityBox	Sets the dimensions of an entity's collision box.
EntityClass	Returns a string containing the class of the specified entity.
EntityCollided	Returns the handle of the entity of the specified type that collided with the specified entity.
EntityColor	Sets the color of an entity.
EntityDistance	Returns the distance between src_entity and dest_entity.
EntityFX	Sets miscellaneous effects for an entity.
EntityInView	Returns true if the specified entity is visible to the specified camera.
EntityMatrix	undocumented.
EntityName	Returns the name of an entity.
EntityOrder	Sets the drawing order for an entity.
EntityParent	Attaches an entity to a parent.
EntityPick	Returns the nearest entity 'ahead' of the specified entity.
EntityPickMode	Sets the pick mode for an entity.
EntityPitch	Returns the pitch angle of an entity.
EntityRadius	Sets the radius of an entity's collision ellipsoid.
EntityRoll	Returns the roll angle of an entity.
EntityScaleX	Returns the scale for the x axis of an entity set with ScaleEntity.
EntityScaleY	Returns the scale for the y axis of an entity set with ScaleEntity.
EntityScaleZ	Returns the scale for the z axis of an entity set with ScaleEntity.
EntityShininess	Sets the specular shininess of an entity.
EntityTexture	Applies a texture to an entity.
EntityType	Sets the collision type for an entity.
EntityVisible	Returns true if src_entity and dest_entity can 'see' each other.
EntityX	The X-coordinate of the entity.
EntityY	The Y-coordinate of the entity.
EntityYaw	Returns the yaw angle of an entity.
EntityZ	The Z-coordinate of the entity.
ExtractAnimSeq	This command allows you to convert an animation with an MD2-style series of anim sequences into a pure Blitz anim sequence.
FindChild	Returns the first child of the specified entity with name matching child_name$
FindSurface	Attempts to find a surface attached to the specified mesh and created with the specified brush.
FitMesh	Scales and translates all vertices of a mesh so that the mesh occupies the specified box.
FlipMesh	Flips all the triangles in a mesh.
FluidArray	Create custom rendering array data for fluid mesh and set width, height and depth.
FluidFunction	Set custom rendering callback function for fluid mesh.
FluidThreshold	Set threshold value used in fluid rendering algorithm, 0.5 is default.
FreeAction	Frees action from memory when it has ended.
FreeBrush	Frees up a brush.
FreeBrushTextures	Frees all brush textures, FreeBrush does not free textures.
FreeEntity	FreeEntity will free up the internal resources associated with a particular entity and remove it from the scene.
FreeShader	Frees a shader material.
FreeShadow	Free stencil shadow.
FreeStencil	Frees a stencil object.
FreeSurface	Frees VBO data and brush.
FreeTexture	Frees up a texture from memory.
GeosphereHeight	Set terrain height normalizing value, 0.05 is default.
GetBrushTexture	Returns the texture that is applied to the specified brush.
GetChild	Returns a child of an entity.
GetEntityBrush	Returns a brush with the same properties as is applied to the specified entity.
GetEntityType	Returns the collision type of an entity as set by the EntityType command.
GetMatElement	Returns the value of an element from within an entity's transformation matrix.
GetMeshLoader	Returns a mesh loader capable of loading extension.
GetParent	Returns an entity's parent.
GetShaderProgram	Get a shader program object reference.
GetString	Gets a Blitz string from a C string.
GetSurface	Returns the handle of the surface attached to the specified mesh and with the specified index number.
GetSurfaceBrush	Returns a brush with the same properties as is applied to the specified mesh surface.
GlobalAnIsotropic	Set global texture anisotropic (default for all), TextureAnIsotropic overrides it.
GlobalHeight	Returns global height of screen resolution.
GlobalResolution	Sets global width and height of screen resolution.
GlobalWidth	Returns global width of screen resolution.
HandleSprite	Sets a sprite handle.
HideEntity	Hides an entity.
LightColor	Sets the color of a light.
LightConeAngles	Sets the 'cone' angle for a 'spot' light.
LightMesh	Performs a 'fake' lighting operation on a mesh.
LightRange	Sets the range of a light.
LinePick	Returns the first entity between x.
LinkShader	Link shader to a program object, as created by CreateShaderMaterial.
LoadAnimMesh	Loads an anim mesh, see MeshLoader.
LoadAnimSeq	Appends an animation sequence from a file to an entity.
LoadBrush	Creates a brush.
LoadGeosphere	Load geodesic sphere terrain from heightmap image.
LoadMaterial	Load a texture from image for 3D texture sampling, use with voxelsprites.
LoadMD2	Loads an md2 entity and returns its handle.
LoadMesh	Loads a single mesh, see MeshLoader.
LoadShader	Load shader from two files, vertex and fragment.
LoadShaderVGF	Load shader from three files, vertex, geometry and fragment.
LoadSprite	Creates a sprite entity.
LoadTerrain	Loads a terrain from an image file and returns the terrain's handle.
ManualCollision	Use manual collision mode between entities, diables automatic collisions.
MeshCSG	Method 0 subtracts mesh2 from mesh1, 1 adds meshes, 2 intersects meshes. Returns a new mesh.
MeshCullRadius	Equivalent of Blitz3D's MeshCullBox command. It sets the radius of a mesh's 'cull sphere'
MeshDepth	Returns the depth of a mesh.
MeshesIntersect	Returns true if the specified meshes are currently intersecting.
MeshHeight	Returns the height of a mesh.
MeshWidth	Returns the width of a mesh.
ModifyGeosphere	Set height of a given point, like ModifyTerrain.
ModifyTerrain	Sets the height of a point on a terrain.
MoveEntity	Moves an entity relative to its current position and orientation.
MSAntiAlias	Enables or disables hardware multisample antialiasing if supported.
NameEntity	Sets an entity's name.
NewAnimationKeys	Create a new TAnimationKeys object.
NewBone	Create a new TBone object.
NewMatPtr	Create a new TMatPtr object, returns a Float Ptr matrix.
NewMesh	Create a new TMesh object.
NewQuatPtr	Create a new TQuatPtr object, returns a Float Ptr quaternion.
NewSprite	Create a new TSprite object.
NewSurface	Create a new TSurface object.
NewTexture	Create a new TTexture object.
NewVecPtr	Create a new TVecPtr object, returns a Float Ptr vector.
OctreeBlock	Place mesh into a node of an octree, the mesh can be duplicated using no more memory.
OctreeMesh	Place mesh into a node of an octree, the mesh can't be duplicated so to do that use CopyEntity.
PaintEntity	Paints a entity with a brush.
PaintMesh	Paints a mesh with a brush.
PaintSurface	Paints a surface with a brush.
ParticleColor	Sets color of batch particle trails.
ParticleTrail	Sets number of batch particles in trail.
ParticleVector	Sets 3d vector of batch particle trails.
PickedEntity	Returns the entity 'picked' by the most recently executed Pick command.
PickedNX	Returns the x component of the normal of the most recently executed Pick command.
PickedNY	Returns the y component of the normal of the most recently executed Pick command.
PickedNZ	Returns the z component of the normal of the most recently executed Pick command.
PickedSurface	Returns the handle of the surface that was 'picked' by the most recently executed Pick command.
PickedTime	Returns the time taken to calculate the most recently executed Pick command.
PickedTriangle	Returns the index number of the triangle that was 'picked' by the most recently executed Pick command.
PickedX	Returns the world x coordinate of the most recently executed Pick command.
PickedY	Returns the world y coordinate of the most recently executed Pick command.
PickedZ	Returns the world z coordinate of the most recently executed Pick command.
PointEntity	Points one entity at another.
PositionAnimMesh	Moves all vertices of mesh and every child mesh.
PositionEntity	Positions an entity at an absolute position in 3D space.
PositionMesh	Moves all vertices of a mesh.
PositionTexture	Positions a texture at an absolute position.
PostFXBuffer	undocumented.
PostFXFunction	undocumented.
PostFXShader	undocumented.
PostFXShaderPass	undocumented.
PostFXTexture	undocumented.
ProjectedX	Returns the viewport x coordinate of the most recently executed CameraProject.
ProjectedY	Returns the viewport y coordinate of the most recently executed CameraProject.
ProjectedZ	Returns the viewport z coordinate of the most recently executed CameraProject.
RenderWorld	Renders the current scene to the BackBuffer onto the rectangle defined by each cameras CameraViewport( )
RepeatMesh	Like CopyMesh but for instancing effects.
ResetEntity	Resets the collision state of an entity.
ResetShadow	Reset created flag to update static shadow.
RotateAnimMesh	Rotates all vertices of mesh and every child mesh.
RotateEntity	Rotates an entity so that it is at an absolute orientation.
RotateMesh	Rotates all vertices of a mesh by the specified rotation.
RotateSprite	Rotates a sprite.
RotateTexture	Rotates a texture.
ScaleAnimMesh	Scales all vertices of mesh and every child mesh.
ScaleEntity	Scales an entity so that it is of an absolute size.
ScaleMesh	Scales all vertices of a mesh by the specified scaling factors.
ScaleSprite	Scales a sprite.
ScaleTexture	Scales a texture by an absolute amount.
SetAnimKey	Sets an animation key for the specified entity at the specified frame.
SetAnimTime	SetAnimTime allows you to manually animate entities.
SetCubeFace	Selects a cube face for direct rendering to a texture.
SetCubeMode	Set the rendering mode of a cubemap texture.
SetFloat	Set a shader variable name of a uniform float type to a float value.
SetFloat2	Set a shader variable name of a uniform vec2 type to 2 float values.
SetFloat3	Set a shader variable name of a uniform vec3 type to 3 float values.
SetFloat4	Set a shader variable name of a uniform vec4 type to 4 float values.
SetInteger	Set a shader variable name of a uniform int type to an integer value.
SetInteger2	Set a shader variable name of a uniform ivec2 type to 2 integer values.
SetInteger3	Set a shader variable name of a uniform ivec3 type to 3 integer values.
SetInteger4	Set a shader variable name of a uniform ivec4 type to 4 integer values.
SetShadowColor	Set color R/G/B in range 0..255 and A in range 0..1.
SetString	Sets a C string from a Blitz string.
ShadeEntity	Apply shader to an entity.
ShadeMesh	Apply shader to a mesh.
ShaderFunction	undocumented.
ShaderMaterial	Set a 3d texture for sampling.
ShaderTexture	Load a texture for 2D texture sampling.
ShadeSurface	Apply shader to a surface.
ShowEntity	Shows an entity.
SkinMesh	Set animated surface for each of the bone no and weights arrays.
SpriteRenderMode	If mode is 1 rendering is normal, 2 is for batch sprites like particles.
SpriteViewMode	Sets the view mode of a sprite.
StencilAlpha	Set stencil alpha value.
StencilClsColor	Set stencil clear screen color in range 0..255.
StencilClsMode	Set stencil clear screen modes.
StencilMesh	Set mesh to be used as stencil.
StencilMode	Set stencil render modes.
StringPtr	Returns string cast of byte pointer.
SurfsRendered	Number of surfaces currently being rendered.
TerrainCountTriangles	Returns terrain triangles count.
TerrainCountVertices	Returns terrain vertices count.
TerrainDetail	Set terrain level of detail, default is 100 and maximum is 2000.
TerrainHeight	Returns the height of the terrain at terrain grid coordinates x.
TerrainScaleTexCoords	Set terrain texture coordinates scale, range is 1 to terrain size.
TerrainX	Returns the interpolated x coordinate on a terrain.
TerrainY	Returns the interpolated y coordinate on a terrain.
TerrainZ	Returns the interpolated z coordinate on a terrain.
TexToBuffer	Copy texture to a pixmap buffer, buffer must be a byte ptr.
TextureAnIsotropic	Set texture anisotropic factor, usually from 2-16.
TextureBlend	Sets the blending mode for a texture.
TextureCoords	Sets the texture coordinate mode for a texture.
TextureFilter	Adds a texture filter.
TextureFlags	Set texture flags, see LoadTexture for values.
TextureGLTexEnvf	GL equivalent, param is a float, limited to 12 calls per texture, experimental.
TextureGLTexEnvi	GL equivalent, param is a const, limited to 12 calls per texture, experimental.
TextureHeight	Returns the height of a texture.
TextureMultitex	Set texture multitex factor, used in interpolate and custom TexBlend options.
TextureName	Returns a texture's absolute filename.
TextureWidth	Returns the width of a texture.
TFormedX	Returns the X component of the last TFormPoint.
TFormedY	Returns the Y component of the last TFormPoint.
TFormedZ	Returns the Z component of the last TFormPoint.
TFormNormal	Transforms between coordinate systems.
TFormPoint	Transforms between coordinate systems.
TFormVector	Transforms between coordinate systems.
TranslateEntity	Translates an entity relative to its current position and not its orientation.
TriangleVertex	Returns the vertex of a triangle corner.
TrisRendered	Number of triangles currently being rendered.
TurnEntity	Turns an entity relative to its current orientation.
UpdateNormals	Recalculates all normals in a mesh.
UpdateTexCoords	Recalculates the surface's uvw coord set 1 based on vertices.
UpdateWorld	Animates all entities in the world.
UseAssimpStreamMeshes	Loader flags for Assimp meshes.
UseCubemapFlip	Flip cubemap texture flag.
UseEntity	undocumented.
UseFloat	Bind a float variable to a shader variable name of a uniform float type.
UseFloat2	Bind 2 float variables to a shader variable name of a uniform vec2 Type.
UseFloat3	Bind 3 float variables to a shader variable name of a uniform vec3 type.
UseFloat4	Bind 4 float variables to a shader variable name of a uniform vec4 type.
UseInteger	Bind an integer variable to a shader variable name of a uniform int type.
UseInteger2	Bind 2 integer variables to a shader variable name of a uniform ivec2 type.
UseInteger3	Bind 3 integer variables to a shader variable name of a uniform ivec3 type.
UseInteger4	Bind 4 integer variables to a shader variable name of a uniform ivec4 type.
UseLibraryMeshes	Loader flag for meshes.
UseLibraryTextures	Loader flag for textures.
UseMatrix	Sends matrix data to a shader variable name of a uniform mat4 type.
UseMatrix3DS	Set 3DS model loader coordinates system (matrix), values should be 0,1,-1.
UseMatrixMD2	Set MD2 model loader coordinates system (matrix), values should be 0,1,-1.
UseMeshDebugLog	Debug all mesh loaders.
UseMeshTextureFlags	Set mesh texture flags.
UseMeshTransform	Transform mesh loaders.
UseStencil	Stencil to use, set to Null to disable stencil.
UseSurface	Sends surface data to a shader variable name.
UseTextureFaces	Order for cubemap faces.
UseTextureFrames	Order for anim texture frames.
VectorPitch	Returns the pitch value of a vector.
VectorYaw	Returns the yaw value of a vector.
VertexAlpha	Returns the alpha component of a vertices color.
VertexBlue	Returns the blue component of a vertices color.
VertexColor	Sets the color of an existing vertex.
VertexCoords	Sets the geometric coordinates of an existing vertex.
VertexGreen	Returns the green component of a vertices color.
VertexNormal	Sets the normal of an existing vertex.
VertexNX	Returns the x component of a vertices normal.
VertexNY	Returns the y component of a vertices normal.
VertexNZ	Returns the z component of a vertices normal.
VertexRed	Returns the red component of a vertices color.
VertexTexCoords	Sets the texture coordinates of an existing vertex.
VertexU	Returns the texture u coordinate of a vertex.
VertexV	Returns the texture v coordinate of a vertex.
VertexW	Returns the texture w coordinate of a vertex.
VertexX	Returns the x coordinate of a vertex.
VertexY	Returns the y coordinate of a vertex.
VertexZ	Returns the z coordinate of a vertex.
VertsRendered	Number of vertices currently being rendered.
VoxelSpriteMaterial	Set material for voxel sprite.
Wireframe	Enables or disables wireframe rendering.

Types Summary

TAction	Action.
TAnimationKeys	AnimationKeys data.
TBlitz2D	Blitz2D.
TBlob	Blob entity.
TBone	Bone entity.
TBrush	Brush.
TCamera	Camera entity.
TConstraint	Constraint.
TEntity	Entity.
TFluid	Fluid mesh entity.
TGeosphere	Geosphere terrain entity.
TGlobal3D	Global.
THardwareInfo	Hardware info.
TLight	Light entity.
TMaterial	Material texture.
TMatPtr	MatPtr functions (Openb3d)
TMatrix	Matrix functions (Minib3d)
TMesh	Mesh entity.
TMeshLoader	Mesh loader.
TOcTree	Octree terrain entity.
TParticleBatch	Particle Batch mesh entity.
TParticleEmitter	Particle Emitter entity.
TPick	Pick.
TPivot	Pivot entity.
TPostFX	Post effects object.
TQuaternion	Quaternion functions (Minib3d)
TQuatPtr	QuatPtr functions (Openb3d)
TRigidBody	Rigid Body.
TShader	Shader.
TShaderObject	Shader object.
TShadowObject	Shadow object.
TSprite	Sprite mesh entity.
TStencil	Stencil.
TSurface	Surface.
TTerrain	Terrain entity.
TTexture	Texture.
TUse	Loader flags for meshes and textures.
TVecPtr	TVecPtr functions (Openb3d)
TVector	TVector functions (Minib3d)
TVoxelSprite	Voxelsprite mesh entity.

Functions

Function ActFadeTo:TAction( ent:TEntity,a:Float,rate:Float )
Description	Fades entity to the given alpha value (0..1) at the speed of rate.

Function ActMoveBy:TAction( ent:TEntity,a:Float,b:Float,c:Float,rate:Float )
Description	Moves entity by an x y z position increment at the speed of rate.

Function ActMoveTo:TAction( ent:TEntity,a:Float,b:Float,c:Float,rate:Float )
Description	Moves entity to the given x y z position at the speed of rate.

Function ActNewtonian:TAction( ent:TEntity,rate:Float )
Description	Translates entity in the direction it is moving, rate should be below 1.

Function ActScaleTo:TAction( ent:TEntity,a:Float,b:Float,c:Float,rate:Float )
Description	Scales entity to the given x y z dimensions at the speed of rate.

Function ActTintTo:TAction( ent:TEntity,a:Float,b:Float,c:Float,rate:Float )
Description	Tints entity to the given r g b value (0..255) at the speed of rate.

Function ActTrackByDistance:TAction( ent:TEntity,target:TEntity,a:Float,rate:Float )
Description	Tracks target entity up to a given distance at the speed of rate.

Function ActTrackByPoint:TAction( ent:TEntity,target:TEntity,a:Float,b:Float,c:Float,rate:Float )
Description	Tracks target entity at a given point from the entity at the speed of rate.

Function ActTurnBy:TAction( ent:TEntity,a:Float,b:Float,c:Float,rate:Float )
Description	Turns entity by an x y z rotation increment at the speed of rate.

Function ActTurnTo:TAction( ent:TEntity,a:Float,b:Float,c:Float,rate:Float )
Description	Turns entity to the given x y z rotation at the speed of rate.

Function ActVector:TAction( ent:TEntity,a:Float,b:Float,c:Float )
Description	Positions entity according the given x y z vector.

Function AddAnimSeq:Int( ent:TEntity,length:Int )

Description

Creates an animation sequence for an entity.

Information

Parameters:

entity - entity handle

length -

Description:

Creates an animation sequence for an entity. This must be done before any animation keys set by SetAnimKey can be used in an actual animation however this is optional. You may use it to "bake" the frames you have added previously using SetAnimKey.

Returns the animation sequence number added.

Function AddMesh( mesh1:TMesh,mesh2:TMesh )

Description

Adds the source mesh to the destination mesh.

Information

Parameters:

source_mesh - source mesh handle

dest_mesh - destination mesh handle

Description:

Adds the source mesh to the destination mesh.

AddMesh works best with meshes that have previously only had mesh commands used with them.

So if you want to manipulate a mesh before adding it to another mesh, make sure you use ScaleMesh, PositionMesh, PaintMesh etc rather than ScaleEntity, PositionEntity, EntityTexture etc before using AddMesh.

However, something to be aware of when using commands such as RotateMesh is that all mesh commands work from a global origin of 0,0,0. Therefore it is generally a good idea to scale and rotate a mesh before positioning it, otherwise your mesh could end up in unexpected positions. Also, when using AddMesh, the origin of the new all-in-one mesh will be set at 0,0,0.

After using AddMesh, the original source_mesh will still exist, therefore use FreeEntity to delete it if you wish to do so.

Function AddRenderTarget( fx:TPostFX,pass_no:Int,numColBufs:Int,depth:Int,format:Int=8,scale:Float=1.0 )
Description	undocumented.

Function AddSurface( mesh:TMesh,surf:TSurface,anim_surf%=False )
Description	Add an existing surface to a mesh.

Function AddTriangle:Int( surf:TSurface,v0:Int,v1:Int,v2:Int )

Description

Adds a triangle to a surface and returns the triangle's index number.

Information

Parameters:

surface - surface handle

v0 - index number of first vertex of triangle

v1 - index number of second vertex of triangle

v2 - index number of third vertex of triangle

Description:

Adds a triangle to a surface and returns the triangle's index number, starting from 0.

The v0, v1 and v2 parameters are the index numbers of the vertices created using AddVertex.

Depending on how the vertices are arranged, then the triangle will only be visible from a certain side. Imagine that a triangle's vertex points are like dot-to-dot pattern, each numbered v0, v1, v2. If these dots, starting from v0, through to V2, form a clockwise pattern relative to the viewer, then the triangle will be visible. If these dots form an anti-clockwise pattern relative to the viewer, then the triangle will not be visible.

The reason for having one-sided triangles is that it reduces the amount of triangles that need to be rendered when one side faces the side of an object which won't be seen (such as the inside of a snooker ball). However, if you wish for a triangle to be two-sided, then you can either create two triangles, using the same set of vertex numbers for both but assigning them in opposite orders, or you can use CopyEntity and FlipMesh together.

Function AddVertex:Int( surf:TSurface,x:Float,y:Float,z:Float,u:Float=0,v:Float=0,w:Float=0 )

Description

Adds a vertex to the specified surface and returns the vertices' index number.

Information

Parameters:

surface - surface handle

x# - x coordinate of vertex

y# - y coordinate of vertex

z# - z coordinate of vertex

u# (optional) - u texture coordinate of vertex

v# (optional) - v texture coordinate of vertex

w# (optional) - w texture coordinate of vertex - not used, included for future expansion

Description:

Adds a vertex to the specified surface and returns the vertices' index number, starting from 0.

x,y,z are the geometric coordinates of the vertex, and u,v,w are texture mapping coordinates.

A vertex is a point in 3D space which is used to connect edges of a triangle together. Without any vertices, you can't have any triangles. At least three vertices are needed to create one triangle; one for each corner.

The optional u, v and w parameters allow you to specify texture coordinates for a vertex, which will determine how any triangle created using those vertices will be texture mapped. The u, v and w parameters specified will take effect on both texture coordinate sets (0 and 1). This works on the following basis:

The top left of an image has the uv coordinates 0,0. The top right has coordinates 1,0 The bottom right is 1,1. The bottom left 0,1.

Thus, uv coordinates for a vertex correspond to a point in the image. For example, coordinates 0.9,0.1 would be near the upper right corner of the image.

So now imagine you have a normal equilateral triangle. By assigning the bottom left vertex a uv coordinate of 0,0, the bottom right a coordinate of 1,0 and the top centre 0.5,1, this will texture map the triangle with an image that fits it.

When adding a vertex its default color is 255,255,255,255.

Function AlignToVector( entity:TEntity,x:Float,y:Float,z:Float,axis:Int,rate:Int=1 )

Description

Aligns an entity axis to a vector.

Information

Parameters:

entity - entity handle

vector_x# - vector x

vector_y# - vector y

vector_z# - vector z

axis - axis of entity that will be aligned to vector

1: x-axis

2: y-axis

3: z-axis

rate# (optional) - rate at which entity is aligned from current orientation to vector orientation. Should be in the range 0 to 1, 0 for smooth transition and 1 for 'snap' transition. Defaults to 1.

Description:

Aligns an entity axis to a vector.

Function AlphaDiscard( tex:TTexture,alpha:Float=0.01 )
Description	Set discard value (as 0..1) above which to ignore pixel's alpha value, default is 1 (only if flag 2)

Function AmbientLight( r:Float,g:Float,b:Float )

Description

Sets the ambient lighting colour.

Information

Parameters:

red# - red ambient light value

green# - green ambient light value

blue# - blue ambient light value

The green, red and blue values should be in the range 0-255. The default ambient light colour is 127,127,127.

Description:

Sets the ambient lighting colour.

Ambient light is a light source that affects all points on a 3D object equally. So with ambient light only, all 3D objects will appear flat, as there will be no shading.

Ambient light is useful for providing a certain level of light, before adding other lights to provide a realistic lighting effect.

An ambient light level of 0,0,0 will result in no ambient light being displayed.

Types

Type TAction
Description	Action.

Type TAnimationKeys
Description	AnimationKeys data.

Type TBlitz2D
Description	Blitz2D.

Type TBlob Extends TEntity
Description	Blob entity.

Type TBone Extends TEntity
Description	Bone entity.

Type TBrush
Description	Brush.

Type TCamera Extends TEntity
Description	Camera entity.

Type TConstraint
Description	Constraint.

Type TEntity
Description	Entity.

Type TFluid Extends TMesh
Description	Fluid mesh entity.

Type TGeosphere Extends TTerrain
Description	Geosphere terrain entity.

Type TGlobal3D
Description	Global.
Information	Renamed to fix conflict with BRL.Reflection.

Type THardwareInfo ' by klepto2
Description	Hardware info.
Information	Contains Function GetInfo() And DisplayInfo(LogFile:Int=False).

Type TLight Extends TEntity
Description	Light entity.

Type TMaterial Extends TTexture
Description	Material texture.

Type TMatPtr
Description	MatPtr functions (Openb3d)

Methods Summary
Copy	Copy self, returns a new matrix.
FromQuaternion	Convert self to a rotation matrix from a quaternion.
FromToRotation	Transformation self to a rotation matrix from two given vectors.
GetInverse	Get inverse of the given TMatPtr and overwrite it, returns nothing.
GetInverse2	Get inverse of the given TMatPtr and overwrite it, returns nothing (used in collision2.cpp)
GetMatrix	Overwrite self with the given TMatrix, returns nothing (like CopyMatrix)
GetMatrixScale	Get scale (magnitude) of self, returns a new vector.
GetPitch	Returns pitch of self.
GetRoll	Returns roll of self.
GetYaw	Returns yaw of self.
LoadIdentity	Set self as identity matrix.
Multiply	Multiply self by the given matrix.
Multiply2	Multiply self by the given matrix (same as Multiply)
Overwrite	Overwrite self with the given TMatPtr.
Rotate	Rotate self by pitch, yaw, roll (Euler degrees)
RotatePitch	Rotate self about the x axis (Euler degrees)
RotateRoll	Rotate self about the z axis (Euler degrees)
RotateYaw	Rotate self about the y axis (Euler degrees)
Scale	Scale self (set the diagonal elements to x, y, z)
SetIdentity	Set matrix identity.
SetTranslate	Set translate vector for self.
ToQuat	Convert self to the given quaternion.
TransformVec	Transform the given vector by self.
Translate	Translate (move) self by the given vector.
Transpose	Transpose self.

Functions Summary
CopyMatrix	Copy the given TMatrix, returns a new Float Ptr matrix (like GetMatrix)
Create	Creates a new TMatPtr object, returns a Float Ptr matrix.
InterpolateMatrix	Interpolate two TMatPtrs by a relative value (used in AlignToVector)
Magnitude	Return magnitude (length) of the given vector, returns a float.
NewMatPtr	Returns a new TMatPtr object.
Quaternion_FromAngleAxis	Create a quaternion from an angle and an axis, sets the given quaternion.
Quaternion_MultiplyQuat	Multiply two quaternions, sets the given quaternion.

Method Copy:TMatPtr()
Description	Copy self, returns a new matrix.

Method FromQuaternion( x:Float,y:Float,z:Float,w:Float )
Description	Convert self to a rotation matrix from a quaternion.

Method FromToRotation( ix:Float,iy:Float,iz:Float,jx:Float,jy:Float,jz:Float )
Description	Transformation self to a rotation matrix from two given vectors.

Method GetInverse( mat:TMatPtr )
Description	Get inverse of the given TMatPtr and overwrite it, returns nothing.

Method GetInverse2( mat:TMatPtr )
Description	Get inverse of the given TMatPtr and overwrite it, returns nothing (used in collision2.cpp)

Method GetMatrix:TMatPtr( mat:TMatrix )
Description	Overwrite self with the given TMatrix, returns nothing (like CopyMatrix)

Method GetMatrixScale:TVecPtr()
Description	Get scale (magnitude) of self, returns a new vector.

Method GetPitch:Float()
Description	Returns pitch of self.

Method GetRoll:Float()
Description	Returns roll of self.

Method GetYaw:Float()
Description	Returns yaw of self.

Method LoadIdentity()
Description	Set self as identity matrix.

Method Multiply( mat:TMatPtr )
Description	Multiply self by the given matrix.

Method Multiply2( mat:TMatPtr )
Description	Multiply self by the given matrix (same as Multiply)

Method Overwrite( mat:TMatPtr )
Description	Overwrite self with the given TMatPtr.

Method Rotate( rx:Float,ry:Float,rz:Float )
Description	Rotate self by pitch, yaw, roll (Euler degrees)

Method RotatePitch( ang:Float )
Description	Rotate self about the x axis (Euler degrees)

Method RotateRoll( ang:Float )
Description	Rotate self about the z axis (Euler degrees)

Method RotateYaw( ang:Float )
Description	Rotate self about the y axis (Euler degrees)

Method Scale( x:Float,y:Float,z:Float )
Description	Scale self (set the diagonal elements to x, y, z)

Method SetIdentity( xx#,xy#,xz#,yx#,yy#,yz#,zx#,zy#,zz# )
Description	Set matrix identity.

Method SetTranslate( x:Float,y:Float,z:Float )
Description	Set translate vector for self.

Method ToQuat( qx:Float Var,qy:Float Var,qz:Float Var,qw:Float Var )
Description	Convert self to the given quaternion.

Method TransformVec( rx:Float Var,ry:Float Var,rz:Float Var,addTranslation:Int=0 )
Description	Transform the given vector by self.

Method Translate( x:Float,y:Float,z:Float )
Description	Translate (move) self by the given vector.

Method Transpose()
Description	Transpose self.

Function CopyMatrix:TMatPtr( mat:TMatrix )
Description	Copy the given TMatrix, returns a new Float Ptr matrix (like GetMatrix)

Function Create:TMatPtr()
Description	Creates a new TMatPtr object, returns a Float Ptr matrix.

Function InterpolateMatrix( m:TMatPtr,a:TMatPtr,alpha:Float )
Description	Interpolate two TMatPtrs by a relative value (used in AlignToVector)

Function Magnitude:Float( x:Float,y:Float,z:Float )
Description	Return magnitude (length) of the given vector, returns a float.

Function NewMatPtr:TMatPtr()
Description	Returns a new TMatPtr object.

Function Quaternion_FromAngleAxis( angle:Float,ax:Float,ay:Float,az:Float,rx:Float Var,ry:Float Var,rz:Float Var,rw:Float Var )
Description	Create a quaternion from an angle and an axis, sets the given quaternion.

Function Quaternion_MultiplyQuat( x1:Float,y1:Float,z1:Float,w1:Float,x2:Float,y2:Float,z2:Float,w2:Float,rx:Float Var,ry:Float Var,rz:Float Var,rw:Float Var )
Description	Multiply two quaternions, sets the given quaternion.

Type TMatrix
Description	Matrix functions (Minib3d)

Methods Summary
Copy	Copy self, returns a new matrix.
GetMatPtr	Overwrite self with the given TMatPtr, returns nothing (like CopyMatPtr)
Inverse	Get inverse of self, returns a new matrix.
LoadIdentity	Set self as identity matrix.
Multiply	Multiply self by the given matrix.
New	Returns a new TMatrix object.
Overwrite	Overwrite self with the given TMatrix.
Rotate	Rotate self by yaw, pitch and roll (Euler degrees)
RotatePitch	Rotate self about the x axis (Euler degrees)
RotateRoll	Rotate self about the z axis (Euler degrees)
RotateYaw	Rotate self about the y axis (Euler degrees)
Scale	Scale self (set the diagonal elements to x, y, z)
SetIdentity	Set matrix identity.
Translate	Translate (move) self.

Functions Summary
CopyMatPtr	Copy the given TMatPtr, returns a new Float matrix (like GetMatPtr)

Method Copy:TMatrix()
Description	Copy self, returns a new matrix.

Method GetMatPtr:TMatrix( mat:TMatPtr )
Description	Overwrite self with the given TMatPtr, returns nothing (like CopyMatPtr)

Method Inverse:TMatrix()
Description	Get inverse of self, returns a new matrix.

Method LoadIdentity()
Description	Set self as identity matrix.

Method Multiply( mat:TMatrix )
Description	Multiply self by the given matrix.

Method New()
Description	Returns a new TMatrix object.

Method Overwrite( mat:TMatrix )
Description	Overwrite self with the given TMatrix.

Method Rotate( rx#,ry#,rz# )
Description	Rotate self by yaw, pitch and roll (Euler degrees)

Method RotatePitch( ang# )
Description	Rotate self about the x axis (Euler degrees)

Method RotateRoll( ang# )
Description	Rotate self about the z axis (Euler degrees)

Method RotateYaw( ang# )
Description	Rotate self about the y axis (Euler degrees)

Method Scale( x#,y#,z# )
Description	Scale self (set the diagonal elements to x, y, z)

Method SetIdentity( xx#,xy#,xz#,yx#,yy#,yz#,zx#,zy#,zz# )
Description	Set matrix identity.

Method Translate( x#,y#,z# )
Description	Translate (move) self.

Function CopyMatPtr:TMatrix( mat:TMatPtr )
Description	Copy the given TMatPtr, returns a new Float matrix (like GetMatPtr)

Type TMesh Extends TEntity
Description	Mesh entity.

Type TMeshLoader
Description	Mesh loader.

Methods Summary
LoadAnimMesh	Call animated mesh loader implementation.
LoadMesh	Call mesh loader implementation.

Method LoadAnimMesh:TMesh(file:TStream, url:Object, parent:TEntity = Null, flags:Int = -1) Abstract
Description	Call animated mesh loader implementation.

Method LoadMesh:TMesh(file:TStream, url:Object, parent:TEntity = Null, flags:Int = -1) Abstract
Description	Call mesh loader implementation.

Type TOcTree Extends TTerrain
Description	Octree terrain entity.

Type TParticleBatch Extends TMesh
Description	Particle Batch mesh entity.

Type TParticleEmitter Extends TEntity
Description	Particle Emitter entity.

Type TPick
Description	Pick.

Type TPivot Extends TEntity
Description	Pivot entity.

Type TPostFX
Description	Post effects object.

Type TQuaternion
Description	Quaternion functions (Minib3d)

Methods Summary
GetQuatPtr	Overwrite self with the given TQuatPtr, returns nothing (like CopyQuatPtr)
New	Returns a new TQuaternion object.

Functions Summary
CopyQuatPtr	Copy the given TQuatPtr, returns a new Float quaternion (like GetQuatPtr)
Create	Create a new TQuaternion from four float values, returns a Float quaternion.
QuatToEuler	Convert a quaternion to the given pitch, yaw, roll (Euler degrees)
QuatToMat	Convert a quaternion to the given TMatrix.
Slerp	Slerp two quaternions to the given quaternion.

Method GetQuatPtr:TQuaternion( quat:TQuatPtr )
Description	Overwrite self with the given TQuatPtr, returns nothing (like CopyQuatPtr)

Method New()
Description	Returns a new TQuaternion object.

Function CopyQuatPtr:TQuaternion( quat:TQuatPtr )
Description	Copy the given TQuatPtr, returns a new Float quaternion (like GetQuatPtr)

Function Create:TQuaternion( w:Float=0,x:Float=0,y:Float=0,z:Float=0 )
Description	Create a new TQuaternion from four float values, returns a Float quaternion.

Function QuatToEuler( w#,x#,y#,z#,pitch# Var,yaw# Var,roll# Var )
Description	Convert a quaternion to the given pitch, yaw, roll (Euler degrees)

Function QuatToMat( w#,x#,y#,z#,mat:TMatrix Var )
Description	Convert a quaternion to the given TMatrix.

Function Slerp:Int( Ax#,Ay#,Az#,Aw#,Bx#,By#,Bz#,Bw#,Cx# Var,Cy# Var,Cz# Var,Cw# Var,t# )
Description	Slerp two quaternions to the given quaternion.

Type TQuatPtr
Description	QuatPtr functions (Openb3d)

Methods Summary
GetQuaternion	Overwrite self with the given TQuaternion, returns nothing (like CopyQuaternion)

Functions Summary
CopyQuaternion	Copy the given TQuaternion, returns a new Float Ptr quaternion (like GetQuaternion)
Create	Create a new TQuatPtr from four float values, returns a Float Ptr quaternion.
NewQuatPtr	Returns a new TQuatPtr object.
QuatToEuler	Convert a quaternion to the given pitch, yaw, roll (Euler degrees)
QuatToMat	Convert a quaternion to the given TMatPtr.
Slerp	Slerp two quaternions to the given quaternion.

Method GetQuaternion:TQuatPtr( quat:TQuaternion )
Description	Overwrite self with the given TQuaternion, returns nothing (like CopyQuaternion)

Function CopyQuaternion:TQuatPtr( quat:TQuaternion )
Description	Copy the given TQuaternion, returns a new Float Ptr quaternion (like GetQuaternion)

Function Create:TQuatPtr( w:Float=0,x:Float=0,y:Float=0,z:Float=0 )
Description	Create a new TQuatPtr from four float values, returns a Float Ptr quaternion.

Function NewQuatPtr:TQuatPtr()
Description	Returns a new TQuatPtr object.

Function QuatToEuler( w:Float,x:Float,y:Float,z:Float,pitch:Float Var,yaw:Float Var,roll:Float Var )
Description	Convert a quaternion to the given pitch, yaw, roll (Euler degrees)

Function QuatToMat( w:Float,x:Float,y:Float,z:Float,mat:TMatPtr )
Description	Convert a quaternion to the given TMatPtr.

Function Slerp:Int( Ax#,Ay#,Az#,Aw#,Bx#,By#,Bz#,Bw#,Cx:Float Var,Cy:Float Var,Cz:Float Var,Cw:Float Var,t# )
Description	Slerp two quaternions to the given quaternion.

Type TRigidBody
Description	Rigid Body.

Type TShader
Description	Shader.

Type TShaderObject
Description	Shader object.

Type TShadowObject
Description	Shadow object.

Type TSprite Extends TMesh
Description	Sprite mesh entity.

Type TStencil
Description	Stencil.

Type TSurface
Description	Surface.

Type TTerrain Extends TEntity
Description	Terrain entity.

Type TTexture
Description	Texture.

Type TUse
Description	Loader flags for meshes and textures.

Type TVecPtr
Description	TVecPtr functions (Openb3d)

Methods Summary
Add	Add self to the given TVecPtr, returns a new vector.
Clear	Clear (zero) vector values, returns nothing.
Copy	Copy self, returns a new vector.
Cross	Cross product of self with the given TVecPtr, returns a new vector.
Distance	Distance between self and the given TVecPtr, returns a float.
Divide	Divide self by a float, returns a new vector.
Divide2	Divide self by the given TVecPtr, returns a new vector.
Dot	Dot product (or squared length) of self with the given TVecPtr, returns a float.
GetVector	Overwrite self with the given TVector, returns nothing (like CopyVector)
Length	Length (or magnitude) of self, returns a float.
Multiply	Multiply self by a float, returns a new vector.
Multiply2	Multiply self by the given TVecPtr, returns a new vector.
Negate	Negate self, returns a new vector.
Normalize	Normalize self, returns nothing.
Normalized	Normalize self, returns a new vector.
Pitch	Pitch (or x angle) in degrees of self, returns a float.
Subtract	Subtract the given TVecPtr from self, returns a new vector.
Yaw	Yaw (or y angle) in degrees of self, returns a float.

Functions Summary
CopyVector	Copy the given TVector, returns a new Float Ptr vector (like GetVector)
Create	Create a new TVecPtr from three float values, returns a Float Ptr vector.
Magnitude	Magnitude (or length) of a vector from three float values, returns a float.
NewVecPtr	Returns a new TVecPtr object.

Method Add:TVecPtr( vec:TVecPtr )
Description	Add self to the given TVecPtr, returns a new vector.

Method Clear()
Description	Clear (zero) vector values, returns nothing.

Method Copy:TVecPtr()
Description	Copy self, returns a new vector.

Method Cross:TVecPtr( vec:TVecPtr )
Description	Cross product of self with the given TVecPtr, returns a new vector.

Method Distance:Float( vec:TVecPtr )
Description	Distance between self and the given TVecPtr, returns a float.

Method Divide:TVecPtr( scale:Float )
Description	Divide self by a float, returns a new vector.

Method Divide2:TVecPtr( vec:TVecPtr )
Description	Divide self by the given TVecPtr, returns a new vector.

Method Dot:Float( vec:TVecPtr )
Description	Dot product (or squared length) of self with the given TVecPtr, returns a float.

Method GetVector:TVecPtr( vec:TVector )
Description	Overwrite self with the given TVector, returns nothing (like CopyVector)

Method Length:Float()
Description	Length (or magnitude) of self, returns a float.

Method Multiply:TVecPtr( scale:Float )
Description	Multiply self by a float, returns a new vector.

Method Multiply2:TVecPtr( vec:TVecPtr )
Description	Multiply self by the given TVecPtr, returns a new vector.

Method Negate:TVecPtr()
Description	Negate self, returns a new vector.

Method Normalize()
Description	Normalize self, returns nothing.

Method Normalized:TVecPtr()
Description	Normalize self, returns a new vector.

Method Pitch:Float()
Description	Pitch (or x angle) in degrees of self, returns a float.

Method Subtract:TVecPtr( vec:TVecPtr )
Description	Subtract the given TVecPtr from self, returns a new vector.

Method Yaw:Float()
Description	Yaw (or y angle) in degrees of self, returns a float.

Function CopyVector:TVecPtr( vec:TVector )
Description	Copy the given TVector, returns a new Float Ptr vector (like GetVector)

Function Create:TVecPtr( x:Float=0,y:Float=0,z:Float=0 )
Description	Create a new TVecPtr from three float values, returns a Float Ptr vector.

Function Magnitude:Float( v0:Float,v1:Float,v2:Float )
Description	Magnitude (or length) of a vector from three float values, returns a float.

Function NewVecPtr:TVecPtr()
Description	Returns a new TVecPtr object.

Type TVector
Description	TVector functions (Minib3d)

Methods Summary
Add	Add self to the given TVector, returns a new vector.
Compare	Compare the given TVector with self, returns 1 or -1.
Copy	Copy self, returns a new vector.
Cross	Cross product of self with the given TVector, returns a new vector.
Distance	Distance between self and the given TVector, returns a float.
Divide	Divide self by a float, returns a new vector.
Divide2	Divide self by the given TVecPtr, returns a new vector.
Dot	Dot product (or squared length) of self with the given TVector.
GetVecPtr	Overwrite self with the given TVecPtr, returns nothing (like CopyVecPtr)
Length	Length (or magnitude) of self, returns a float.
Multiply	Multiply self by a float, returns a new vector.
Multiply2	Multiply self by the given TVecPtr, returns a new vector.
New	Returns a new TVector object.
Normalize	Normalize self, returns nothing.
SetLength	Set normalized length of self, returns a float.
SquaredLength	Squared length of self, returns a float.
Subtract	Subtract the given TVector from self, returns a new vector.

Functions Summary
CopyVecPtr	Copy the given TVecPtr, returns a new Float vector (like GetVecPtr)
Create	Create a new TVector from three float values, returns a Float vector.

Method Add:TVector( vec:TVector )
Description	Add self to the given TVector, returns a new vector.

Method Compare:Int( with:Object )
Description	Compare the given TVector with self, returns 1 or -1.

Method Copy:TVector()
Description	Copy self, returns a new vector.

Method Cross:TVector( vec:TVector )
Description	Cross product of self with the given TVector, returns a new vector.

Method Distance:Float( vec:TVector )
Description	Distance between self and the given TVector, returns a float.

Method Divide:TVector( val# )
Description	Divide self by a float, returns a new vector.

Method Divide2:TVector( vec:TVector )
Description	Divide self by the given TVecPtr, returns a new vector.

Method Dot:Float( vec:TVector )
Description	Dot product (or squared length) of self with the given TVector.

Method GetVecPtr:TVector( vec:TVecPtr )
Description	Overwrite self with the given TVecPtr, returns nothing (like CopyVecPtr)

Method Length#()
Description	Length (or magnitude) of self, returns a float.

Method Multiply:TVector( val# )
Description	Multiply self by a float, returns a new vector.

Method Multiply2:TVector( vec:TVector )
Description	Multiply self by the given TVecPtr, returns a new vector.

Method New()
Description	Returns a new TVector object.

Method Normalize()
Description	Normalize self, returns nothing.

Method SetLength#( val# )
Description	Set normalized length of self, returns a float.

Method SquaredLength#()
Description	Squared length of self, returns a float.

Method Subtract:TVector( vec:TVector )
Description	Subtract the given TVector from self, returns a new vector.

Function CopyVecPtr:TVector( vec:TVecPtr )
Description	Copy the given TVecPtr, returns a new Float vector (like GetVecPtr)

Function Create:TVector( x#,y#,z# )
Description	Create a new TVector from three float values, returns a Float vector.

Type TVoxelSprite Extends TMesh
Description	Voxelsprite mesh entity.

Module Information

Version	1.26
License	zlib
Copyright	Wrapper - 2014-2021 Mark Mcvittie, Bruce A Henderson
Copyright	Library - 2010-2021 Angelo Rosina

Function AmbientShader( material:TShader )
Description	Set default shader for surfaces.

Function AppendAction( act1:TAction,act2:TAction )
Description	Adds action to the end of another one, where act1 happens before act2.

Function AttachFragShader:Int( shader:TShader,myShader:TShaderObject )
Description	Attaches a fragment shader object to a program object, attach vertex first or older compilers will crash.

Function AttachVertShader:Int( shader:TShader,myShader:TShaderObject )
Description	Attaches a vertex shader object to a program object.

Function BackBufferToTex( tex:TTexture,mipmap_no:Int=0,frame:Int=0,fastinvert:Int=True )
Description	Copy the contents of the backbuffer to a texture.
Information	OpenB3D does not have the same buffer commands as Blitz3D. The region copied from the backbuffer will start at 0,0 and end at the texture's width and height. So if you want to copy a 3D scene to a texture, first resize the camera viewport to the texture size, use RenderWorld to render the camera, then use this command. Back buffer is upside-down so set fastinvert to True to invert texture uvs, False to flip texture data (slower).

Function BeginMax2D( version:Int=1 )
Description	Old begin function as in Minib3d is 0, new begin function is 1 (default)

Function BrushGLBlendFunc( brush:TBrush,sfactor:Int,dfactor:Int )
Description	GL equivalent, experimental.

Function BrushGLColor( brush:TBrush,r:Float,g:Float,b:Float,a:Float=1.0 )
Description	GL equivalent, experimental.

Function BufferToTex( tex:TTexture,buffer:Byte Ptr,frame:Int=0 ) ' frame currently does nothing
Description	Copy pixmap buffer to texture, buffer must be a byte ptr.

Function CameraProjMatrix:Float Ptr( cam:TCamera )
Description	undocumented.

Function CameraToTex( tex:TTexture,cam:TCamera,frame:Int=0 ) ' frame currently does nothing
Description	Copy rendered camera view to texture.

Function CheckFramebufferStatus( target% )
Description	Check for framebuffer errors.

Function CopyBrush:TBrush( brush:TBrush )
Description	Returns a copy of the new brush.

Function CopyList( list:TList )
Description	Copy a list or vector. To copy a field list use as a method.
Information	Use either mesh with surf_list/anim_surf_list/bones or ent with child_list.

Function CopyRect( srcX:Int,srcY:Int,srcW:Int,srcH:Int,dstW:Int,dstH:Int,src:Byte Ptr,dst:Byte Ptr,bPP:Int=4,invert:Int=0 )
Description	Copy rectangle of source pixmap pixels to destination, not exactly like B3D.
Information	srcW/H is src size, srcX/srcY top-left position, dstW/H is dst size, bytes per pixel defaults to 4.

Function CopySurface:TSurface( surf:TSurface )
Description	Returns a copy of the new surface.

Function CopyTexture:TTexture( tex:TTexture,flags:Int )
Description	Returns a copy of the new texture.

Function CountMipmaps:Int( tex:TTexture )
Description	Returns the number of mipmaps a texture has.

Function CreateBlob:TBlob( fluid:TFluid,radius:Float,parent_ent:TEntity=Null )
Description	Create blob from a fluid mesh where radius is the size of the blob.

Function CreateBone:TBone( mesh:TMesh,parent_ent:TEntity=Null )
Description	Create bone.

Function CreateConstraint:TConstraint( p1:TEntity,p2:TEntity,l:Float )
Description	Create constraint force between two entities of given length, doesn't affect rotation.

Function CreateFluid:TFluid()
Description	Create fluid mesh for blobs to use.

Function CreateFragShader:TShaderObject( shader:TShader,shaderFileName:String )
Description	Returns a new frag shader object from file.

Function CreateFragShaderString:TShaderObject( shader:TShader,shadercode:String )
Description	Returns a new frag shader object from string.

Function CreateGeosphere:TGeosphere( size:Int,parent:TEntity=Null )
Description	Create geodesic sphere and set terrain size.

Function CreateOcTree:TOcTree( w:Float,h:Float,d:Float,parent_ent:TEntity=Null )
Description	Create octree and set its width, height and depth.

Function CreateParticleEmitter:TParticleEmitter( particle:TEntity,parent_ent:TEntity=Null )
Description	Create particle emitter and set sprite for it to use.

Function CreatePostFX:TPostFX( cam:TCamera,passes:Int=1 )
Description	undocumented.

Function CreateQuad:TMesh( parent:TEntity=Null )
Description	Create flat quad.

Function CreateRigidBody:TRigidBody( body:TEntity,p1:TEntity,p2:TEntity,p3:TEntity,p4:TEntity )
Description	Create rigid physics body attached to four entities.