CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

iRender3D Struct Reference
[3D]

New 3D Interface. More...

#include <render3d.h>

Inheritance diagram for iRender3D:

iBase List of all members.

Public Methods

virtual bool Open ()=0
 Open 3d renderer. More...

virtual void Close ()=0
 Close renderer and release all resources used. More...

virtual iGraphics2DGetDriver2D ()=0
 Get a pointer to our 2d canvas driver. More...

virtual iTextureManagerGetTextureManager ()=0
 Get a pointer to our texture manager. More...

virtual iRenderBufferManager * GetBufferManager ()=0
 Get a pointer to the VB-manager Always use the manager referenced here to get VBs. More...

virtual iLightingManager * GetLightingManager ()=0
 Get a pointer to lighting manager. More...

virtual bool ActivateBuffer (csVertexAttrib attrib, iRenderBuffer *buffer)=0
 Activate a vertex buffer. More...

virtual void DeactivateBuffer (csVertexAttrib attrib)=0
 Deactivate a vertex buffer. More...

virtual bool ActivateTexture (iTextureHandle *txthandle, int unit=0)=0
 Activate a texture. More...

virtual bool ActivateTexture (iMaterialHandle *matwrapper, int layer, int unit=0)=0
 Activate a texture (Should probably handled some better way). More...

virtual void DeactivateTexture (int unit=0)=0
 Deactivate a texture. More...

virtual void SetDimensions (int width, int height)=0
 Set dimensions of window. More...

virtual int GetWidth ()=0
 Get width of window. More...

virtual int GetHeight ()=0
 Get height of window. More...

virtual csRender3dCapsGetCaps ()=0
 Capabilities of the driver. More...

virtual void SetPerspectiveCenter (int x, int y)=0
 Set center of projection. More...

virtual void GetPerspectiveCenter (int &x, int &y)=0
 Get center of projection. More...

virtual void SetPerspectiveAspect (float aspect)=0
 Set perspective aspect. More...

virtual float GetPerspectiveAspect ()=0
 Get perspective aspect. More...

virtual void SetObjectToCamera (csReversibleTransform *wvmatrix)=0
 Set world to view transform. More...

virtual void SetRenderTarget (iTextureHandle *handle, bool persistent=false)=0
 Set the target of rendering. More...

virtual iTextureHandleGetRenderTarget ()=0
 Get the current render target (NULL for screen). More...

virtual bool BeginDraw (int drawflags)=0
 Begin drawing in the renderer. More...

virtual void FinishDraw ()=0
 Indicate that drawing is finished. More...

virtual void Print (csRect *area)=0
 Do backbuffer printing. More...

virtual void DrawMesh (csRenderMesh *mymesh)=0
 Drawroutine. Only way to draw stuff. More...

virtual void SetWriteMask (bool red, bool green, bool blue, bool alpha)=0
 Set the masking of color and/or alpha values to framebuffer. More...

virtual void GetWriteMask (bool &red, bool &green, bool &blue, bool &alpha)=0
 Get the masking of color and/or alpha values to framebuffer. More...

virtual void EnableZOffset ()=0
 Enables offsetting of Z values. More...

virtual void DisableZOffset ()=0
 Disables offsetting of Z values. More...

virtual void SetShadowState (int state)=0
 Controls shadow drawing. More...

virtual void DrawLine (const csVector3 &v1, const csVector3 &v2, float fov, int color)=0
 Draw a line. More...

virtual void SetClipper (iClipper2D *clipper, int cliptype)=0
 Set optional clipper to use. More...

virtual iClipper2DGetClipper ()=0
 Get clipper that was used. More...

virtual int GetClipType ()=0
 Return type of clipper. More...

virtual void SetNearPlane (const csPlane3 &pl)=0
 Set near clip plane. More...

virtual void ResetNearPlane ()=0
 Reset near clip plane (i.e. disable it). More...

virtual const csPlane3GetNearPlane ()=0
 Get near clip plane. More...

virtual bool HasNearPlane ()=0
 Return true if we have near plane. More...

virtual int GetMaxLights ()=0
 Get maximum number of simultaneous HW lights supported. More...

virtual void SetLightParameter (int i, int param, csVector3 value)=0
 Sets a parameter for light i. More...

virtual void EnableLight (int i)=0
 Enables light i. More...

virtual void DisableLight (int i)=0
 Disables light i. More...

virtual void EnablePVL ()=0
 Enable vertex lighting. More...

virtual void DisablePVL ()=0
 Disable vertex lighting. More...

virtual csStringSetGetStringContainer ()=0
 Get a stringhash to be used by our streamsources etc. More...

virtual bool SetRenderState (R3D_RENDERSTATEOPTION op, long val)=0
 Set a renderstate value. More...

virtual long GetRenderState (R3D_RENDERSTATEOPTION op)=0
 Get a renderstate value. More...


Detailed Description

New 3D Interface.

Work in progress!

Definition at line 294 of file render3d.h.


Member Function Documentation

virtual bool iRender3D::ActivateBuffer csVertexAttrib    attrib,
iRenderBuffer   buffer
[pure virtual]
 

Activate a vertex buffer.

virtual bool iRender3D::ActivateTexture iMaterialHandle   matwrapper,
int    layer,
int    unit = 0
[pure virtual]
 

Activate a texture (Should probably handled some better way).

virtual bool iRender3D::ActivateTexture iTextureHandle   txthandle,
int    unit = 0
[pure virtual]
 

Activate a texture.

virtual bool iRender3D::BeginDraw int    drawflags [pure virtual]
 

Begin drawing in the renderer.

virtual void iRender3D::Close   [pure virtual]
 

Close renderer and release all resources used.

virtual void iRender3D::DeactivateBuffer csVertexAttrib    attrib [pure virtual]
 

Deactivate a vertex buffer.

virtual void iRender3D::DeactivateTexture int    unit = 0 [pure virtual]
 

Deactivate a texture.

virtual void iRender3D::DisableLight int    i [pure virtual]
 

Disables light i.

virtual void iRender3D::DisablePVL   [pure virtual]
 

Disable vertex lighting.

virtual void iRender3D::DisableZOffset   [pure virtual]
 

Disables offsetting of Z values.

virtual void iRender3D::DrawLine const csVector3   v1,
const csVector3   v2,
float    fov,
int    color
[pure virtual]
 

Draw a line.

virtual void iRender3D::DrawMesh csRenderMesh *    mymesh [pure virtual]
 

Drawroutine. Only way to draw stuff.

virtual void iRender3D::EnableLight int    i [pure virtual]
 

Enables light i.

virtual void iRender3D::EnablePVL   [pure virtual]
 

Enable vertex lighting.

virtual void iRender3D::EnableZOffset   [pure virtual]
 

Enables offsetting of Z values.

virtual void iRender3D::FinishDraw   [pure virtual]
 

Indicate that drawing is finished.

virtual iRenderBufferManager* iRender3D::GetBufferManager   [pure virtual]
 

Get a pointer to the VB-manager Always use the manager referenced here to get VBs.

virtual csRender3dCaps* iRender3D::GetCaps   [pure virtual]
 

Capabilities of the driver.

virtual iClipper2D* iRender3D::GetClipper   [pure virtual]
 

Get clipper that was used.

virtual int iRender3D::GetClipType   [pure virtual]
 

Return type of clipper.

virtual iGraphics2D* iRender3D::GetDriver2D   [pure virtual]
 

Get a pointer to our 2d canvas driver.

NOTE: It's not increfed, and therefore it shouldn't be decref-ed by caller.

virtual int iRender3D::GetHeight   [pure virtual]
 

Get height of window.

virtual iLightingManager* iRender3D::GetLightingManager   [pure virtual]
 

Get a pointer to lighting manager.

virtual int iRender3D::GetMaxLights   [pure virtual]
 

Get maximum number of simultaneous HW lights supported.

virtual const csPlane3& iRender3D::GetNearPlane   [pure virtual]
 

Get near clip plane.

virtual float iRender3D::GetPerspectiveAspect   [pure virtual]
 

Get perspective aspect.

virtual void iRender3D::GetPerspectiveCenter int &    x,
int &    y
[pure virtual]
 

Get center of projection.

virtual long iRender3D::GetRenderState R3D_RENDERSTATEOPTION    op [pure virtual]
 

Get a renderstate value.

virtual iTextureHandle* iRender3D::GetRenderTarget   [pure virtual]
 

Get the current render target (NULL for screen).

virtual csStringSet* iRender3D::GetStringContainer   [pure virtual]
 

Get a stringhash to be used by our streamsources etc.

virtual iTextureManager* iRender3D::GetTextureManager   [pure virtual]
 

Get a pointer to our texture manager.

virtual int iRender3D::GetWidth   [pure virtual]
 

Get width of window.

virtual void iRender3D::GetWriteMask bool &    red,
bool &    green,
bool &    blue,
bool &    alpha
[pure virtual]
 

Get the masking of color and/or alpha values to framebuffer.

virtual bool iRender3D::HasNearPlane   [pure virtual]
 

Return true if we have near plane.

virtual bool iRender3D::Open   [pure virtual]
 

Open 3d renderer.

virtual void iRender3D::Print csRect   area [pure virtual]
 

Do backbuffer printing.

virtual void iRender3D::ResetNearPlane   [pure virtual]
 

Reset near clip plane (i.e. disable it).

virtual void iRender3D::SetClipper iClipper2D   clipper,
int    cliptype
[pure virtual]
 

Set optional clipper to use.

If clipper == null then there is no clipper. Currently only used by DrawTriangleMesh.

virtual void iRender3D::SetDimensions int    width,
int    height
[pure virtual]
 

Set dimensions of window.

virtual void iRender3D::SetLightParameter int    i,
int    param,
csVector3    value
[pure virtual]
 

Sets a parameter for light i.

virtual void iRender3D::SetNearPlane const csPlane3   pl [pure virtual]
 

Set near clip plane.

virtual void iRender3D::SetObjectToCamera csReversibleTransform   wvmatrix [pure virtual]
 

Set world to view transform.

virtual void iRender3D::SetPerspectiveAspect float    aspect [pure virtual]
 

Set perspective aspect.

virtual void iRender3D::SetPerspectiveCenter int    x,
int    y
[pure virtual]
 

Set center of projection.

virtual bool iRender3D::SetRenderState R3D_RENDERSTATEOPTION    op,
long    val
[pure virtual]
 

Set a renderstate value.

virtual void iRender3D::SetRenderTarget iTextureHandle   handle,
bool    persistent = false
[pure virtual]
 

Set the target of rendering.

If this is NULL then the target will be the main screen. Otherwise it is a texture. After calling g3d->FinishDraw() the target will automatically be reset to NULL (main screen). Note that on some implementions rendering on a texture will overwrite the screen. So you should only do this BEFORE you start rendering your frame.

If 'persistent' is true then the current contents of the texture will be copied on screen before drawing occurs (in the first call to BeginDraw). Otherwise it is assumed that you fully render the texture.

virtual void iRender3D::SetShadowState int    state [pure virtual]
 

Controls shadow drawing.

virtual void iRender3D::SetWriteMask bool    red,
bool    green,
bool    blue,
bool    alpha
[pure virtual]
 

Set the masking of color and/or alpha values to framebuffer.


The documentation for this struct was generated from the following file:
Generated for Crystal Space by doxygen 1.2.14