BRender Technical Reference Manual:Contents
Top

Contents


Contents
1 Introduction
Overview
What is BRender?
BRender turns a description of a scene into an image
Why is BRender so good?
2 Organisation of this Manual
Objective
Audience
Coverage
Organisation
Using this Manual
Typographic conventions
3 Functions (Structured Reference)
Library Initialisation & Termination
Initialisation
BrBegin()
Termination
BrEnd()
Scene Modelling
The Actor
Hierarchical Relationships
Positional Relationship
Functions
The Reference Actor
The Model Actor
The Light Actor
The Camera Actor
Other Actors
Co-ordinate Spaces
Converting between Co-ordinate Spaces
BrScreenZToCamera()
BrScreenXYZToCamera()
Scene Rendering
The Rendering Engine
Initialising the Renderer
BrZbBegin()
BrZsBegin()
Pre-Rendering Pre-Processing
Hidden Surface Removal Schemes
BrZbDepthToScreenZ()
BrZbScreenZToDepth()
BrZsDepthToScreenZ()
BrZsScreenZToDepth()
Rendering Functions
BrZbSceneRender()
BrZsSceneRender()
BrZbSceneRenderBegin()
BrZsSceneRenderBegin()
BrZbSceneRenderAdd()
BrZsSceneRenderAdd()
BrZbSceneRenderEnd()
BrZsSceneRenderEnd()
BrZbRenderBoundsCallbackSet()
BrZsRenderBoundsCallbackSet()
BrZsPrimitiveCallbackSet()
Terminating the Renderer
BrZbEnd()
BrZsEnd()
Image Support
Pixel Maps
BrPixelmapDirtyRectangleFill()
BrPixelmapDirtyRectangleCopy()
BrPixelmapDoubleBuffer()
Pick Functions
Maths
C Types
Fundamental Types
Angles
Scalars
Fractions
Vectors
Matrices
Euler Angle Sets
Unit Quaternions
Resource Management
BrResAllocate()
BrResAdd()
BrResStrDup()
BrResClass()
BrResSize()
BrResChildEnum()
BrResRemove()
BrResFree()
Memory Management
Dynamic Memory
BrBlockFill()
BrBlockCopy()
BrMemInquire()
BrMemAllocate()
BrMemCalloc()
BrMemStrDup()
BrMemFree()
Filing System Support
Standard Filing System Services
BrFileAttributes()
BrFileOpenWrite()
BrFileWrite()
BrFilePrintf()
BrFilePutLine()
BrFilePutChar()
BrFileOpenRead()
BrFileRead()
BrFileGetLine()
BrFileGetChar()
BrFileAdvance()
BrFileEOF()
BrFileClose()
Special Filing System Services
BrWriteModeSet()
Diagnostic Support
Classifying Failure
Handling Failure
Debug & Release Builds
Debugging
Reporting Diagnostics
Errors Reported by BRender
Specifying a Diagnostic Handler
Miscellaneous
Input Device Support
BrMatrix34RollingBall()
Platform Specific Support
All Platforms
Games consoles
DOS
Windows (16 bit)
Windows (32 bit)
Macintosh
Other
4 Data Structures (Alphabetical Reference)
br_actor
The Structure
Members
Operations
BrActorAdd()
BrActorRemove()
BrActorRelink()
BrActorToActorMatrix34()
BrActorToBounds()
BrScenePick3D()
BrActorToScreenMatrix4()
BrScenePick2D()
BrEnvironmentSet()
BrLightEnable()
BrLightDisable()
BrClipPlaneEnable()
BrClipPlaneDisable()
Copy/Assign
Access & Maintenance
BrZsActorOrderTableSet()
BrZsActorOrderTableGet()
Referencing & Lifetime
Initialisation
Construction & Destruction
BrActorAllocate()
BrActorFree()
Supplementary
BrActorEnum()
BrActorSearch()
BrActorSearchMany()
Import & Export
BrActorFileCount()
BrActorSave()
BrActorLoad()
BrActorSaveMany()
BrActorLoadMany()
br_actor_enum_cbfn
The Call-Back Function
Specification
CBFnActorEnum()
br_allocator
The Structure
Members
Operations
BrAllocatorSet()
Copy/Assign
Access & Maintenance
Referencing & Lifetime
Initialisation
Construction & Destruction
Supplementary
br_angle
The Integral Type
Arithmetic
Comparison
Conversion
Copy/Assign
br_boolean
The Integral Type
Arithmetic
Comparison
Conversion
Copy/Assign
br_bounds
The Structure
Members
Operations
BrBoundsToMatrix34()
Copy/Assign
Initialisation
br_camera
The Structure
Members
Copy/Assign
Access & Maintenance
Referencing & Lifetime
Initialisation
Construction & Destruction
Supplementary
Import & Export
br_colour
The Integral Type
Arithmetic
Comparison
Conversion
Copy/Assign
br_diag_failure_cbfn
The Call-Back Function
Specification
CBFnDiagFailure()
br_diag_warning_cbfn
The Call-Back Function
Specification
CBFnDiagWarning()
br_diaghandler
The Structure
Members
Operations
BrDiagHandlerSet()
Copy/Assign
Access & Maintenance
Referencing & Lifetime
Initialisation
Construction & Destruction
Supplementary
br_euler
The Structure
Members
Arithmetic
Conversion
BrEulerToQuat()
BrEulerToMatrix34()
BrEulerToMatrix4()
Copy/Assign
Initialisation
br_face
The Structure
Members
Copy/Assign
Access & Maintenance
Referencing & Lifetime
Initialisation
Construction & Destruction
Supplementary
Import & Export
br_filesystem
The Structure
Members
Operations
BrFilesystemSet()
Copy/Assign
Access & Maintenance
Referencing & Lifetime
Initialisation
Construction & Destruction
Supplementary
br_fixed_[ls][su][f]
The Integral Types
Arithmetic
Comparison
Conversion
Copy/Assign
br_font
The Structure
Members
Copy/Assign
Access & Maintenance
Referencing & Lifetime
Initialisation
Import & Export
br_fraction
The Integral Type
Arithmetic
Comparison
Conversion
Copy/Assign
br_fvector2
The Structure
Members
Arithmetic
Copy/Assign
Initialisation
br_fvector3
The Structure
Members
Arithmetic
Copy/Assign
Initialisation
br_fvector4
The Structure
Members
Arithmetic
Copy/Assign
Initialisation
br_int_8/16/32
The Integral Type
Arithmetic
Comparison
Conversion
Copy/Assign
br_light
The Structure
Members
Copy/Assign
Access & Maintenance
Referencing & Lifetime
Initialisation
Construction & Destruction
Supplementary
Import & Export
Platform Specific
br_map_enum_cbfn
The Call-Back Function
Specification
CBFnMapEnum()
br_map_find_cbfn
The Call-Back Function
Specification
CBFnMapFind()
br_material
The Structure
Members
Copy/Assign
Access & Maintenance
BrMaterialAdd()
BrMaterialAddMany()
BrMaterialUpdate()
BrMaterialRemove()
BrMaterialRemoveMany()
Referencing & Lifetime
Initialisation
Construction & Destruction
BrMaterialAllocate()
BrMaterialFree()
Supplementary
BrMaterialCount()
BrMaterialEnum()
BrMaterialFind()
BrMaterialFindMany()
BrMaterialFindHook()
BrMaterialFindFailedLoad()
Import & Export
BrMaterialFileCount()
BrMaterialLoad()
BrMaterialLoadMany()
BrFmtScriptMaterialLoad()
BrFmtScriptMaterialLoadMany()
BrMaterialSave()
BrMaterialSaveMany()
Platform Specific
br_material_enum_cbfn
The Call-Back Function
Specification
CBFnMaterialEnum()
br_material_find_cbfn
The Call-Back Function
Specification
CBFnMaterialFind()
br_matrix23
The Structure
Members
Arithmetic
BrMatrix23Mul()
BrMatrix23Inverse()
BrMatrix23LPInverse()
BrMatrix23ApplyP()
BrMatrix23ApplyV()
BrMatrix23TApplyP()
BrMatrix23TApplyV()
BrMatrix23Pre()
BrMatrix23PreTranslate()
BrMatrix23PreScale()
BrMatrix23PreShearX()
BrMatrix23PreShearY()
BrMatrix23PreRotate()
BrMatrix23Post()
BrMatrix23PostTranslate()
BrMatrix23PostScale()
BrMatrix23PostShearX()
BrMatrix23PostShearY()
BrMatrix23PostRotate()
Copy/Assign
BrMatrix23Copy()
Access & Maintenance
BrMatrix23LPNormalise()
Referencing & Lifetime
Initialisation
BrMatrix23Identity()
BrMatrix23Translate()
BrMatrix23Scale()
BrMatrix23ShearX()
BrMatrix23ShearY()
BrMatrix23Rotate()
br_matrix34
The Structure
Members
Arithmetic
BrMatrix34Mul()
BrMatrix34Inverse()
BrMatrix34LPInverse()
BrMatrix34Apply()
BrMatrix34ApplyP()
BrMatrix34ApplyV()
BrMatrix34TApply()
BrMatrix34TApplyP()
BrMatrix34TApplyV()
BrMatrix34Pre()
BrMatrix34PreTranslate()
BrMatrix34PreScale()
BrMatrix34PreShearX()
BrMatrix34PreShearY()
BrMatrix34PreShearZ()
BrMatrix34PreRotate()
BrMatrix34PreRotateX()
BrMatrix34PreRotateY()
BrMatrix34PreRotateZ()
BrMatrix34PreTransform()
BrMatrix34Post()
BrMatrix34PostTranslate()
BrMatrix34PostScale()
BrMatrix34PostShearX()
BrMatrix34PostShearY()
BrMatrix34PostShearZ()
BrMatrix34PostRotate()
BrMatrix34PostRotateX()
BrMatrix34PostRotateY()
BrMatrix34PostRotateZ()
BrMatrix34PostTransform()
Conversion
BrMatrix34ToEuler()
BrMatrix34ToQuat()
BrMatrix34ToTransform()
Copy/Assign
BrMatrix34Copy()
BrMatrix34Copy4()
Access & Maintenance
BrMatrix34LPNormalise()
Referencing & Lifetime
Initialisation
BrMatrix34Identity()
BrMatrix34Translate()
BrMatrix34Scale()
BrMatrix34ShearX()
BrMatrix34ShearY()
BrMatrix34ShearZ()
BrMatrix34RotateX()
BrMatrix34RotateY()
BrMatrix34RotateZ()
BrMatrix34Rotate()
br_matrix4
The Structure
Members
Arithmetic
BrMatrix4Mul()
BrMatrix4Inverse()
BrMatrix4Apply()
BrMatrix4ApplyP()
BrMatrix4ApplyV()
BrMatrix4TApply()
BrMatrix4TApplyP()
BrMatrix4TApplyV()
BrMatrix4Pre34()
BrMatrix4PreTransform()
BrMatrix4Adjoint()
BrMatrix4Determinant()
Conversion
BrMatrix4ToEuler()
BrMatrix4ToQuat()
Copy/Assign
BrMatrix4Copy()
BrMatrix4Copy34()
Referencing & Lifetime
Initialisation
BrMatrix4Identity()
BrMatrix4Scale()
BrMatrix4Perspective()
br_mode_test_cbfn
The Call-Back Function
Specification
CBFnModeTest()
br_model
The Structure
Members
Operations
BrModelPick2D()
BrModelApplyMap()
BrModelFitMap()
BrSceneModelLight()
Copy/Assign
Access & Maintenance
BrModelAdd()
BrModelAddMany()
BrModelUpdate()
BrModelRemove()
BrModelRemoveMany()
Referencing & Lifetime
Initialisation
Construction & Destruction
BrModelAllocate()
BrModelFree()
Supplementary
BrModelCount()
BrModelEnum()
BrModelFind()
BrModelFindMany()
BrModelFindHook()
BrModelFindFailedLoad()
Import & Export
BrModelFileCount()
BrModelLoad()
BrModelLoadMany()
BrFmtASCLoad()
BrFmtNFFLoad()
BrModelSave()
BrModelSaveMany()
br_model_custom_cbfn
The Call-Back Function
Specification
CBFnModelCustom()
Operations
BrZbModelRender()
BrZsModelRender()
BrOnScreenCheck()
BrOriginToScreenXY()
BrPointToScreenXY()
BrPointToScreenXYMany()
BrOriginToScreenXYZO()
BrPointToScreenXYZO()
BrPointToScreenXYZOMany()
br_model_enum_cbfn
The Call-Back Function
Specification
CBFnModelEnum()
br_model_find_cbfn
The Call-Back Function
Specification
CBFnModelFind()
br_modelpick2d_cbfn
The Call-Back Function
Specification
CBFnModelPick2D()
br_order_table
The Structure
Members
Operations
BrZsOrderTablePrimitiveInsert()
BrZsOrderTablePrimaryEnable()
BrZsOrderTablePrimaryDisable()
Copy/Assign
Access & Maintenance
BrZsOrderTableClear()
Referencing & Lifetime
Initialisation
Construction & Destruction
BrZsOrderTableAllocate()
BrZsOrderTableFree()
br_pick2d_cbfn
The Call-Back Function
Specification
CBFnPick2D()
br_pick3d_cbfn
The Call-Back Function
Specification
CBFnPick3D()
br_pixelmap
The Structure
Members
Operations
BrPixelmapFill()
BrPixelmapRectangleFill()
BrPixelmapLine()
BrPixelmapPixelSet()
BrPixelmapPixelGet()
BrPixelmapText()
BrPixelmapTextF()
BrPixelmapTextWidth()
BrPixelmapTextHeight()
Copy/Assign
BrPixelmapCopy()
BrPixelmapRectangleCopy()
Access & Maintenance
BrMapAdd()
BrMapAddMany()
BrMapUpdate()
BrMapRemove()
BrMapRemoveMany()
BrTableAdd()
BrTableAddMany()
BrTableUpdate()
BrTableRemove()
BrTableRemoveMany()
Referencing & Lifetime
Initialisation
Construction & Destruction
BrPixelmapAllocate()
BrPixelmapAllocateSub()
BrPixelmapMatch()
BrPixelmapClone()
BrPixelmapFree()
Supplementary
BrPixelmapPixelSize()
BrPixelmapChannels()
BrMapCount()
BrMapEnum()
BrMapFind()
BrMapFindMany()
BrMapFindHook()
BrMapFindFailedLoad()
BrTableCount()
BrTableEnum()
BrTableFind()
BrTableFindMany()
BrTableFindHook()
BrTableFindFailedLoad()
Import & Export
BrPixelmapFileCount()
BrPixelmapLoad()
BrPixelmapLoadMany()
BrFmtBMPLoad()
BrFmtGIFLoad()
BrFmtIFFLoad()
BrFmtTGALoad()
BrPixelmapSave()
BrPixelmapSaveMany()
br_pool
The Structure
Members
Operations
BrPoolBlockAllocate()
BrPoolBlockFree()
BrPoolEmpty()
Copy/Assign
Access & Maintenance
Referencing & Lifetime
Initialisation
Construction & Destruction
BrPoolAllocate()
BrPoolFree()
Supplementary
br_pool_block
The Structure
Members
Copy/Assign
Access & Maintenance
Referencing & Lifetime
Initialisation
Construction & Destruction
br_primitive
The Structure
Members
Copy/Assign
Access & Maintenance
Referencing & Lifetime
Construction & Destruction
br_primitive_cbfn
The Call-Back Function
Specification
CBFnPrimitive()
Operations
BrZsPrimitiveBucketSelect()
br_quat
The Structure
Members
Arithmetic
BrQuatMul()
BrQuatInvert()
BrQuatSlerp()
Conversion
BrQuatToEuler()
BrQuatToMatrix34()
BrQuatToMatrix4()
Copy/Assign
Access & Maintenance
BrQuatNormalise()
Initialisation
br_renderbounds_cbfn
The Call-Back Function
Specification
CBFnRenderBounds()
Operations
br_resclass_enum_cbfn
The Call-Back Function
Specification
CBFnResClassEnum()
br_resclass_find_cbfn
The Call-Back Function
Specification
CBFnResClassFind()
br_resenum_cbfn
The Call-Back Function
Specification
CBFnResEnum()
br_resource_class
The Structure
Members
Operations
BrResClassAdd()
BrResClassAddMany()
BrResClassRemove()
BrResClassRemoveMany()
Copy/Assign
Access & Maintenance
Referencing & Lifetime
Initialisation
Construction & Destruction
Supplementary
BrResClassFind()
BrResClassFindMany()
BrResClassFindHook()
BrResClassCount()
BrResClassEnum()
br_resourcefree_cbfn
The Call-Back Function
Specification
CBFnResourceFree()
br_scalar
The Integral Type
Arithmetic
Comparison
Conversion
Copy/Assign
br_size_t
The Integral Type
Arithmetic
Comparison
Conversion
Copy/Assign
br_table_enum_cbfn
The Call-Back Function
Specification
CBFnTableEnum()
br_table_find_cbfn
The Call-Back Function
Specification
CBFnTableFind()
br_transform
The Structure
Members
Arithmetic
Conversion
BrTransformToMatrix34()
BrTransformToTransform()
Copy/Assign
Access & Maintenance
Referencing & Lifetime
Initialisation
br_ufraction
The Integral Type
Arithmetic
Comparison
Conversion
Copy/Assign
br_uint_8/16/32
The Integral Type
Arithmetic
Comparison
Conversion
Copy/Assign
br_vector2
The Structure
Members
Arithmetic
BrVector2Negate()
BrVector2Add()
BrVector2Accumulate()
BrVector2Sub()
BrVector2Scale()
BrVector2InvScale()
BrVector2Dot()
BrVector2Length()
BrVector2LengthSquared()
BrVector2Normalise()
Copy/Assign
BrVector2Copy()
Referencing & Lifetime
Initialisation
BrVector2Set()
BrVector2SetFloat()
BrVector2SetInt()
br_vector3
The Structure
Members
Arithmetic
BrVector3Negate()
BrVector3Add()
BrVector3Accumulate()
BrVector3Sub()
BrVector3Scale()
BrVector3InvScale()
BrVector3Dot()
BrVector3Cross()
BrVector3Length()
BrVector3LengthSquared()
BrVector3Normalise()
BrVector3NormaliseQuick()
BrVector3NormaliseLP()
Copy/Assign
BrVector3Copy()
Referencing & Lifetime
Initialisation
BrVector3Set()
BrVector3SetFloat()
BrVector3SetInt()
br_vector4
The Structure
Members
Arithmetic
BrVector4Dot()
Copy/Assign
BrVector4Copy()
Referencing & Lifetime
Initialisation
br_vertex
Overview
Members
Copy/Assign
Access & Maintenance
Referencing & Lifetime
Initialisation
Construction & Destruction
Supplementary
Import & Export
brfile_advance_cbfn
The Call-Back Function
Specification
CBFnFileAdvance()
brfile_attributes_cbfn
The Call-Back Function
Specification
CBFnFileAttributes()
brfile_close_cbfn
The Call-Back Function
Specification
CBFnFileClose()
brfile_eof_cbfn
The Call-Back Function
Specification
CBFnFileEOF()
brfile_getchr_cbfn
The Call-Back Function
Specification
CBFnFileGetChr()
brfile_getline_cbfn
The Call-Back Function
Specification
CBFnFileGetLine()
brfile_open_read_cbfn
The Call-Back Function
Specification
CBFnFileOpenRead()
brfile_open_write_cbfn
The Call-Back Function
Specification
CBFnFileOpenWrite()
brfile_putchr_cbfn
The Call-Back Function
Specification
CBFnFilePutChr()
brfile_putline_cbfn
The Call-Back Function
Specification
CBFnFilePutLine()
brfile_read_cbfn
The Call-Back Function
Specification
CBFnFileRead()
brfile_write_cbfn
The Call-Back Function
Specification
CBFnFileWrite()
brmem_allocate_cbfn
The Call-Back Function
Specification
CBFnMemAllocate()
brmem_free_cbfn
The Call-Back Function
Specification
CBFnMemFree()
brmem_inquire_cbfn
The Call-Back Function
Specification
CBFnMemInquire()
General Index

Generated with CERN WebMaker