| sidesign.minib3d: | Functions | Modinfo | Source |

# minib3d

## Functions Summary

AddMesh | Online Help
AddTriangle | Online Help
AddVertex | Online Help
AmbientLight | Online Help
Animate | Online Help
Animating | Online Help
AnimLength | Online Help
AnimSeq | Online Help
AnimTime | Online Help
AntiAlias | Online Help
BackBufferToTex | Minib3d Only.
BrushAlpha | Online Help
BrushBlend | Online Help
BrushColor | Online Help
BrushFX | Online Help
BrushShininess | Online Help
BrushTexture | Online Help
CameraClsColor | Online Help
CameraClsMode | Online Help
CameraFogColor | Online Help
CameraFogMode | Online Help
CameraFogRange | Online Help
CameraPick | Online Help
CameraProject | Online Help
CameraProjMode | Online Help
CameraRange | Online Help
CameraViewport | Online Help
CameraZoom | Online Help
ClearCollisions | Online Help
ClearSurface | Online Help
ClearTextureFilters | Online Help
ClearWorld | Online Help
CollisionEntity | Online Help
CollisionNX | Online Help
CollisionNY | Online Help
CollisionNZ | Online Help
Collisions | Online Help
CollisionSurface | Online Help
CollisionTime | Online Help
CollisionTriangle | Online Help
CollisionX | Online Help
CollisionY | Online Help
CollisionZ | Online Help
CopyEntity | Online Help
CopyMesh | Online Help
CountChildren | Online Help
CountCollisions | Online Help
CountSurfaces | Online Help
CountTriangles | Online Help
CountVertices | Online Help
CreateBrush | Online Help
CreateCamera | Online Help
CreateCone | Online Help
CreateCube | Online Help
CreateCylinder | Online Help
CreateLight | Online Help
CreateMesh | Online Help
CreatePivot | Online Help
CreateSphere | Online Help
CreateSurface | Online Help
CreateTexture | Online Help
DeltaPitch | Online Help
DeltaYaw | Online Help
EntityAlpha | Online Help
EntityAutoFade | Online Help
EntityBlend | Online Help
EntityBox | Online Help
EntityClass | Online Help
EntityCollided | Online Help
EntityColor | Online Help
EntityDistance | Online Help
EntityFX | Online Help
EntityInView | Online Help
EntityName | Online Help
EntityOrder | Online Help
EntityParent | Online Help
EntityPick | Online Help
EntityPickMode | Online Help
EntityPitch | Online Help
EntityRadius | Online Help
EntityRoll | Online Help
EntityShininess | Online Help
EntityTexture | Online Help
EntityType | Online Help
EntityVisible | Online Help
EntityX | Online Help
EntityY | Online Help
EntityYaw | Online Help
EntityZ | Online Help
ExtractAnimSeq | Online Help
FindChild | Online Help
FindSurface | Online Help
FitMesh | Online Help
FlipMesh | Online Help
FreeBrush | Online Help
FreeEntity | Online Help
FreeTexture | Online Help
GetBrushTexture | Online Help
GetChild | Online Help
GetEntityBrush | Online Help
GetEntityType | Online Help
GetMatElement | Online Help
GetParent | Online Help
GetSurface | Online Help
GetSurfaceBrush | Online Help
Graphics3D | Online Help
HandleSprite | Online Help
HideEntity | Online Help
LightColor | Online Help
LightConeAngles | Online Help
LightRange | Online Help
LinePick | Online Help
LoadAnimMesh | Online Help
LoadAnimTexture | Online Help
LoadBrush | Online Help
LoadMesh | Online Help
LoadSprite | Online Help
LoadTexture | Online Help
MeshCullRadius | Minib3d Only.
MeshDepth | Online Help
MeshHeight | Online Help
MeshWidth | Online Help
MoveEntity | Online Help
NameEntity | Online Help
PaintEntity | Online Help
PaintMesh | Online Help
PaintSurface | Online Help
PickedEntity | Online Help
PickedNX | Online Help
PickedNY | Online Help
PickedNZ | Online Help
PickedSurface | Online Help
PickedTime | Online Help
PickedTriangle | Online Help
PickedX | Online Help
PickedY | Online Help
PickedZ | Online Help
PointEntity | Online Help
PositionEntity | Online Help
PositionMesh | Online Help
PositionTexture | Online Help
ProjectedX | Online Help
ProjectedY | Online Help
ProjectedZ | Online Help
RenderWorld | Online Help
ResetEntity | Online Help
RotateEntity | Online Help
RotateMesh | Online Help
RotateSprite | Online Help
RotateTexture | Online Help
ScaleEntity | Online Help
ScaleMesh | Online Help
ScaleSprite | Online Help
ScaleTexture | Online Help
SetAnimTime | Online Help
SetCubeFace | Online Help
SetCubeMode | Online Help
ShowEntity | Online Help
SpriteViewMode | Online Help
TextureBlend | Online Help
TextureCoords | Online Help
TextureFilter | Online Help
TextureHeight | Online Help
TextureName | Online Help
TextureWidth | Online Help
TFormedX | Online Help
TFormedY | Online Help
TFormedZ | Online Help
TFormNormal | Online Help
TFormPoint | Online Help
TFormVector | Online Help
TranslateEntity | Online Help
TriangleVertex | Online Help
TurnEntity | Online Help
UpdateNormals | Online Help
UpdateWorld | Online Help
VectorPitch | Online Help
VectorYaw | Online Help
VertexAlpha | Online Help
VertexBlue | Online Help
VertexColor | Online Help
VertexCoords | Online Help
VertexGreen | Online Help
VertexNormal | Online Help
VertexNX | Online Help
VertexNY | Online Help
VertexNZ | Online Help
VertexRed | Online Help
VertexTexCoords | Online Help
VertexU | Online Help
VertexV | Online Help
VertexW | Online Help
VertexX | Online Help
VertexY | Online Help
VertexZ | Online Help
Wireframe | Online Help

## Functions

Function AddMesh:TMesh(mesh1:TMesh,mesh2:TMesh)
Description | Online Help

Function AddTriangle(surf:TSurface,v0,v1,v2)
Description | Online Help

Function AddVertex(surf:TSurface,x#,y#,z#,u#=0.0,v#=0.0,w#=0.0)
Description | Online Help

Function AmbientLight(r#,g#,b#)
Description | Online Help

Function Animate(ent:TEntity,mode=1,speed#=1.0,seq=0,trans=0)
Description | Online Help

Function Animating(ent:TEntity)
Description | Online Help

Function AnimLength(ent:TEntity)
Description | Online Help

Function AnimSeq(ent:TEntity)
Description | Online Help

Function AnimTime#(ent:TEntity)
Description | Online Help

Function AntiAlias(samples)
Description | Online Help

Function BackBufferToTex(tex:TTexture,mipmap_no=0,frame=0)
Description | Minib3d Only.
Information | This command is included as MiniB3D currently does not have the same buffer commands as Blitz3D. Use this command to copy a region of the backbuffer to a texture. The region copied from the backbuffer will start at (0,0), and end at the texture's width and height. Therefore if you want to copy the whole of a 3D scene to a texture, you must first resize the camera viewport to the size of the texture, use RenderWorld to render the camera, then use this command to copy the backbuffer to the texture. Note that if a texture has the mipmap flag enabled (by default it does), then this command must be called for each mipmap, otherwise the texture will appear to fade into a different, non-matching mipmap as you move away from it. A routine similar to the one below will copy the backbuffer to each mipmap, making sure the camera viewport is the same size as the mipmap. For i=0 Until tex.CountMipmaps() CameraViewport 0,0,tex.MipmapWidth(),tex.MipmapHeight() Renderworld BackBufferToTex(tex,i) Next It may be easier to disable the mipmap flag for the texture. To do so, use ClearTextureFilters after calling Graphics3D (the mipmap flag is a default filter). If you are using this command to copy to a cubemap texture, use SetCubeFace to first select which portion of the texture you will be copying to. Note that in MiniB3D mipmaps are not used by cubemaps, so ignore the information about mipmaps for normal textures above. See the cubemap.bmx example included with MiniB3D to learn more about cubemapping.

Function BrushAlpha(brush:TBrush,a#)
Description | Online Help

Function BrushBlend(brush:TBrush,blend)
Description | Online Help

Function BrushColor(brush:TBrush,r#,g#,b#)
Description | Online Help

Function BrushFX(brush:TBrush,fx)
Description | Online Help

Function BrushShininess(brush:TBrush,s#)
Description | Online Help

Function BrushTexture(brush:TBrush,tex:TTexture,frame=0,index=0)
Description | Online Help

Function CameraClsColor(cam:TCamera,r#,g#,b#)
Description | Online Help

Function CameraClsMode(cam:TCamera,cls_depth,cls_zbuffer)
Description | Online Help

Function CameraFogColor(cam:TCamera,r#,g#,b#)
Description | Online Help

Function CameraFogMode(cam:TCamera,mode)
Description | Online Help

Function CameraFogRange(cam:TCamera,near#,far#)
Description | Online Help

Function CameraPick:TEntity(cam:TCamera,x#,y#)
Description | Online Help

Function CameraProject(cam:TCamera,x#,y#,z#)
Description | Online Help

Function CameraProjMode(cam:TCamera,mode)
Description | Online Help

Function CameraRange(cam:TCamera,near#,far#)
Description | Online Help

Function CameraViewport(cam:TCamera,x,y,width,height)
Description | Online Help

Function CameraZoom(cam:TCamera,zoom#)
Description | Online Help

Function ClearCollisions()
Description | Online Help

Function ClearSurface(surf:TSurface,clear_verts=True,clear_tris=True)
Description | Online Help

Function ClearTextureFilters()
Description | Online Help

Function ClearWorld(entities=True,brushes=True,textures=True)
Description | Online Help

Function CollisionEntity:TEntity(ent:TEntity,index)
Description | Online Help

Function CollisionNX#(ent:TEntity,index)
Description | Online Help

Function CollisionNY#(ent:TEntity,index)
Description | Online Help

Function CollisionNZ#(ent:TEntity,index)
Description | Online Help

Function Collisions(src_no,dest_no,method_no,response_no=0)
Description | Online Help

Function CollisionSurface:TSurface(ent:TEntity,index)
Description | Online Help

Function CollisionTime#(ent:TEntity,index)
Description | Online Help

Function CollisionTriangle(ent:TEntity,index)
Description | Online Help

Function CollisionX#(ent:TEntity,index)
Description | Online Help

Function CollisionY#(ent:TEntity,index)
Description | Online Help

Function CollisionZ#(ent:TEntity,index)
Description | Online Help

Function CopyEntity:TEntity(ent:TEntity,parent:TEntity=Null)
Description | Online Help

Function CopyMesh:TMesh(mesh:TMesh,parent:TEntity=Null)
Description | Online Help

Function CountChildren(ent:TEntity)
Description | Online Help

Function CountCollisions(ent:TEntity)
Description | Online Help

Function CountSurfaces(mesh:TMesh)
Description | Online Help

Function CountTriangles(surf:TSurface)
Description | Online Help

Function CountVertices(surf:TSurface)
Description | Online Help

Function CreateBrush:TBrush(r#=255.0,g#=255.0,b#=255.0)
Description | Online Help

Function CreateCamera:TCamera(parent:TEntity=Null)
Description | Online Help

Function CreateCone:TMesh(segments=8,solid=True,parent:TEntity=Null)
Description | Online Help

Function CreateCube:TMesh(parent:TEntity=Null)
Description | Online Help

Function CreateCylinder:TMesh(segments=8,solid=True,parent:TEntity=Null)
Description | Online Help

Function CreateLight:TLight(light_type=1,parent:TEntity=Null)
Description | Online Help

Function CreateMesh:TMesh(parent:TEntity=Null)
Description | Online Help

Function CreatePivot:TPivot(parent:TEntity=Null)
Description | Online Help

Function CreateSphere:TMesh(segments=8,parent:TEntity=Null)
Description | Online Help

Function CreateSurface:TSurface(mesh:TMesh,brush:TBrush=Null)
Description | Online Help

Function CreateTexture:TTexture(width,height,flags=1,frames=1)
Description | Online Help

Function DeltaPitch#(ent1:TEntity,ent2:TEntity)
Description | Online Help

Function DeltaYaw#(ent1:TEntity,ent2:TEntity)
Description | Online Help

Function EntityAlpha(ent:TEntity,alpha#)
Description | Online Help

Function EntityAutoFade(ent:TEntity,near#,far#)
Description | Online Help

Function EntityBlend(ent:TEntity,blend)
Description | Online Help

Function EntityBox(ent:TEntity,x#,y#,z#,w#,h#,d#)
Description | Online Help

Function EntityClass$(ent:TEntity)
Description | Online Help

Function EntityCollided:TEntity(ent:TEntity,type_no)
Description | Online Help

Function EntityColor(ent:TEntity,red#,green#,blue#)
Description | Online Help

Function EntityDistance#(ent1:TEntity,ent2:TEntity)
Description | Online Help

Function EntityFX(ent:TEntity,fx)
Description | Online Help

Function EntityInView(ent:TEntity,cam:TCamera)
Description | Online Help

Function EntityName$(ent:TEntity)
Description | Online Help

Function EntityOrder(ent:TEntity,order)
Description | Online Help

Function EntityParent(ent:TEntity,parent_ent:TEntity,glob=True)
Description | Online Help

Function EntityPick:TEntity(ent:TEntity,range#)
Description | Online Help

Function EntityPickMode(ent:TEntity,pick_mode,obscurer=True)
Description | Online Help

Function EntityPitch#(ent:TEntity,glob=False)
Description | Online Help

Function EntityRadius(ent:TEntity,radius_x#,radius_y#=0.0)
Description | Online Help

Function EntityRoll#(ent:TEntity,glob=False)
Description | Online Help

Function EntityShininess(ent:TEntity,shine#)
Description | Online Help

Function EntityTexture(ent:TEntity,tex:TTexture,frame=0,index=0)
Description | Online Help

Function EntityType(ent:TEntity,type_no,recursive=False)
Description | Online Help

Function EntityVisible(src_ent:TEntity,dest_ent:TEntity)
Description | Online Help

Function EntityX#(ent:TEntity,glob=False)
Description | Online Help

Function EntityY#(ent:TEntity,glob=False)
Description | Online Help

Function EntityYaw#(ent:TEntity,glob=False)
Description | Online Help

Function EntityZ#(ent:TEntity,glob=False)
Description | Online Help

Function ExtractAnimSeq(ent:TEntity,first_frame,last_frame,seq=0)
Description | Online Help

Function FindChild:TEntity(ent:TEntity,child_name$)
Description | Online Help

Function FindSurface:TSurface(mesh:TMesh,brush:TBrush)
Description | Online Help

Function FitMesh:TMesh(mesh:TMesh,x#,y#,z#,width#,height#,depth#,uniform=False)
Description | Online Help

Function FlipMesh:TMesh(mesh:TMesh)
Description | Online Help

Function FreeBrush(brush:TBrush)
Description | Online Help

Function FreeEntity(ent:TEntity)
Description | Online Help

Function FreeTexture:TTexture(tex:TTexture)
Description | Online Help

Function GetBrushTexture:TTexture(brush:TBrush,index=0)
Description | Online Help

Function GetChild:TEntity(ent:TEntity,child_no)
Description | Online Help

Function GetEntityBrush:TBrush(ent:TEntity)
Description | Online Help

Function GetEntityType(ent:TEntity)
Description | Online Help

Function GetMatElement#(ent:TEntity,row,col)
Description | Online Help

Function GetParent:TEntity(ent:TEntity)
Description | Online Help

Function GetSurface:TSurface(mesh:TMesh,surf_no)
Description | Online Help

Function GetSurfaceBrush:TBrush(surf:TSurface)
Description | Online Help

Function Graphics3D(width,height,depth=0,mode=0,rate=60)
Description | Online Help

Function HandleSprite(sprite:TSprite,h_x#,h_y#)
Description | Online Help

Function HideEntity(ent:TEntity)
Description | Online Help

Function LightColor(light:TLight,red#,green#,blue#)
Description | Online Help

Function LightConeAngles(light:TLight,inner_ang#,outer_ang#)
Description | Online Help

Function LightRange(light:TLight,range#)
Description | Online Help

Function LinePick:TEntity(x#,y#,z#,dx#,dy#,dz#,radius#=0.0)
Description | Online Help

Function LoadAnimMesh:TMesh(file$,parent:TEntity=Null)
Description | Online Help

Function LoadAnimTexture:TTexture(file$,flags,frame_width,frame_height,first_frame,frame_count)
Description | Online Help

Function LoadBrush:TBrush(file$,flags=1,u_scale#=1.0,v_scale#=1.0)
Description | Online Help

Function LoadMesh:TMesh(file$,parent:TEntity=Null)
Description | Online Help

Function LoadSprite:TSprite(tex_file$,tex_flag=1,parent:TEntity=Null)
Description | Online Help

Function LoadTexture:TTexture(file$,flags=1)
Description | Online Help

Function MeshCullRadius(ent:TEntity,radius#)
Description | Minib3d Only.
Information | This command is the equivalent of Blitz3D's MeshCullBox command. It is used to set the radius of a mesh's 'cull sphere' - if the 'cull sphere' is not inside the viewing area, the mesh will not be rendered. A mesh's cull radius is set automatically, therefore in most cases you will not have to use this command. One time you may have to use it is for animated meshes where the default cull radius may not take into account all animation positions, resulting in the mesh being wrongly culled at extreme positions.

Function MeshDepth#(mesh:TMesh)
Description | Online Help

Function MeshHeight#(mesh:TMesh)
Description | Online Help

Function MeshWidth#(mesh:TMesh)
Description | Online Help

Function MoveEntity(ent:TEntity,x#,y#,z#)
Description | Online Help

Function NameEntity(ent:TEntity,name$)
Description | Online Help

Function PaintEntity(ent:TEntity,brush:TBrush)
Description | Online Help

Function PaintMesh:TMesh(mesh:TMesh,brush:TBrush)
Description | Online Help

Function PaintSurface(surf:TSurface,brush:TBrush)
Description | Online Help

Function PickedEntity:TEntity()
Description | Online Help

Function PickedNX#()
Description | Online Help

Function PickedNY#()
Description | Online Help

Function PickedNZ#()
Description | Online Help

Function PickedSurface:TSurface()
Description | Online Help

Function PickedTime#()
Description | Online Help

Function PickedTriangle()
Description | Online Help

Function PickedX#()
Description | Online Help

Function PickedY#()
Description | Online Help

Function PickedZ#()
Description | Online Help

Function PointEntity(ent:TEntity,target_ent:TEntity,roll#=0)
Description | Online Help

Function PositionEntity(ent:TEntity,x#,y#,z#,glob=False)
Description | Online Help

Function PositionMesh:TMesh(mesh:TMesh,px#,py#,pz#)
Description | Online Help

Function PositionTexture(tex:TTexture,u_pos#,v_pos#)
Description | Online Help

Function ProjectedX#()
Description | Online Help

Function ProjectedY#()
Description | Online Help

Function ProjectedZ#()
Description | Online Help

Function RenderWorld()
Description | Online Help

Function ResetEntity(ent:TEntity)
Description | Online Help

Function RotateEntity(ent:TEntity,x#,y#,z#,glob=False)
Description | Online Help

Function RotateMesh:TMesh(mesh:TMesh,pitch#,yaw#,roll#)
Description | Online Help

Function RotateSprite(sprite:TSprite,ang#)
Description | Online Help

Function RotateTexture(tex:TTexture,ang#)
Description | Online Help

Function ScaleEntity(ent:TEntity,x#,y#,z#,glob=False)
Description | Online Help

Function ScaleMesh:TMesh(mesh:TMesh,sx#,sy#,sz#)
Description | Online Help

Function ScaleSprite(sprite:TSprite,s_x#,s_y#)
Description | Online Help

Function ScaleTexture(tex:TTexture,u_scale#,v_scale#)
Description | Online Help

Function SetAnimTime(ent:TEntity,time#,seq=0)
Description | Online Help

Function SetCubeFace(tex:TTexture,face)
Description | Online Help

Function SetCubeMode(tex:TTexture,mode)
Description | Online Help

Function ShowEntity(ent:TEntity)
Description | Online Help

Function SpriteViewMode(sprite:TSprite,mode)
Description | Online Help

Function TextureBlend(tex:TTexture,blend)
Description | Online Help

Function TextureCoords(tex:TTexture,coords)
Description | Online Help

Function TextureFilter(match_text$,flags)
Description | Online Help

Function TextureHeight(tex:TTexture)
Description | Online Help

Function TextureName$(tex:TTexture)
Description | Online Help

Function TextureWidth(tex:TTexture)
Description | Online Help

Function TFormedX#()
Description | Online Help

Function TFormedY#()
Description | Online Help

Function TFormedZ#()
Description | Online Help

Function TFormNormal(x#,y#,z#,src_ent:TEntity,dest_ent:TEntity)
Description | Online Help

Function TFormPoint(x#,y#,z#,src_ent:TEntity,dest_ent:TEntity)
Description | Online Help

Function TFormVector(x#,y#,z#,src_ent:TEntity,dest_ent:TEntity)
Description | Online Help

Function TranslateEntity(ent:TEntity,x#,y#,z#,glob=False)
Description | Online Help

Function TriangleVertex(surf:TSurface,tri_no,corner)
Description | Online Help

Function TurnEntity(ent:TEntity,x#,y#,z#,glob=False)
Description | Online Help

Function UpdateNormals(mesh:TMesh)
Description | Online Help

Function UpdateWorld(anim_speed#=1.0)
Description | Online Help

Function VectorPitch#(vx#,vy#,vz#)
Description | Online Help

Function VectorYaw#(vx#,vy#,vz#)
Description | Online Help

Function VertexAlpha#(surf:TSurface,vid)
Description | Online Help

Function VertexBlue#(surf:TSurface,vid)
Description | Online Help

Function VertexColor(surf:TSurface,vid,r#,g#,b#,a#=1.0)
Description | Online Help

Function VertexCoords(surf:TSurface,vid,x#,y#,z#)
Description | Online Help

Function VertexGreen#(surf:TSurface,vid)
Description | Online Help

Function VertexNormal(surf:TSurface,vid,nx#,ny#,nz#)
Description | Online Help

Function VertexNX#(surf:TSurface,vid)
Description | Online Help

Function VertexNY#(surf:TSurface,vid)
Description | Online Help

Function VertexNZ#(surf:TSurface,vid)
Description | Online Help

Function VertexRed#(surf:TSurface,vid)
Description | Online Help

Function VertexTexCoords(surf:TSurface,vid,u#,v#,w#=0.0,coord_set=0)
Description | Online Help

Function VertexU#(surf:TSurface,vid,coord_set=0)
Description | Online Help

Function VertexV#(surf:TSurface,vid,coord_set=0)
Description | Online Help

Function VertexW#(surf:TSurface,vid,coord_set=0)
Description | Online Help

Function VertexX#(surf:TSurface,vid)
Description | Online Help

Function VertexY#(surf:TSurface,vid)
Description | Online Help

Function VertexZ#(surf:TSurface,vid)
Description | Online Help

Function Wireframe(enable)
Description | Online Help

## Module Information

Version | 0.52
Main Author | Simon Harrison (simonh@blitzbasic.com). Includes routines by various authors.
License | You are free to use this code as you please