crystalspace.jbind.interfaces.iengine.renderloop
Interface iRenderLoopManager

All Superinterfaces:

iBase, iPointer

All Known Implementing Classes:

csRenderLoopManager

public interface iRenderLoopManager

extends iBase

Render loop manager. Use to create new loops and manage loop names. Remarks: It's not recommended to unregister the loop with the name of CS_DEFAULT_RENDERLOOP_NAME.

Author:

Java wrapper - Quentin Anciaux, c++ version - http://crystal.sourceforge.net/docs/online/pubapi/structiRenderLoopManager.php

Method Summary

iRenderLoop	create() Create a new render loop.
java.lang.String	getName(iRenderLoop loop) Get the name asociated to the render loop.
boolean	register(java.lang.String name, iRenderLoop loop) Associate a name with a renderloop.
iRenderLoop	retrieve(java.lang.String name) Get the render loop associated with the name.
boolean	unregister(iRenderLoop loop) Remove an association between a name and a render loop.

Methods inherited from interface crystalspace.jbind.interfaces.iutil.scf.iBase

decRef, getName, getRefCount, getVersion, incRef, queryInterface, queryInterfaceSafe

Methods inherited from interface crystalspace.jbind.interfaces.iPointer

changePointer, getPointer, isMemoryOwner, setMemoryOwner

Method Detail

create

public iRenderLoop create()

Create a new render loop. Remarks: This render loop is "unnamed". To name it, use Register().

Returns:

getName

public java.lang.String getName(iRenderLoop loop)

Get the name asociated to the render loop. Parameters: loop Render loop which associated name is to be retrieved. Returns: Name of the loop. 0 if the loop isn't registered.

Parameters:

loop -

Returns:

register

public boolean register(java.lang.String name,
                        iRenderLoop loop)

Associate a name with a renderloop. One name is associated with one render loop. If you try to register a loop with a name that is already used, Register() will fail. Parameters: name Name the render loop is registered with. loop The render loop. Returns: Whether the loop could be registered with the name. Fails if either the name is already used or the loop is already registered.

Parameters:

name -

loop -

Returns:

retrieve

public iRenderLoop retrieve(java.lang.String name)

Get the render loop associated with the name. Parameters: name Name for which the renderloop is to be retrieved. Returns: The render loop associated with the name, or 0 when no loop is registered with that name.

Parameters:

name -

Returns:

unregister

public boolean unregister(iRenderLoop loop)

Remove an association between a name and a render loop. Parameters: loop Render loop which associated name should be removed. Returns: Whether the association was successfully removed.

Parameters:

loop -

Returns: