CrystalSpace

Public API Reference

iBase Struct Reference
[Shared Class Facility (SCF)]

This is the basic interface: all other interfaces should be derived from this one, this will allow us to always use at least some minimal functionality given any interface pointer. More...

#include <csutil/scf_interface.h>

Inherited by CS::PluginCommon::ShaderWeaver::iCombiner [virtual], CS::PluginCommon::ShaderWeaver::iCombinerLoader [virtual], CS::PluginCommon::SoftShader::iDefaultScanlineRenderer [virtual], CS::PluginCommon::SoftShader::iDefaultShader [virtual], CS::PluginCommon::SoftShader::iScanlineRenderer [virtual], CS::PluginCommon::SoftShader::iSoftShaderRenderInterface [virtual], iAddonReference [virtual], iAnimatedImage [virtual], iAnimatedMesh [virtual], iAnimatedMeshFactory [virtual], iAnimatedMeshFactorySubMesh [virtual], iAnimatedMeshMorphTarget [virtual], iAnimatedMeshSocket [virtual], iAnimatedMeshSocketFactory [virtual], iAnimatedMeshSubMesh [virtual], iAnimTimeUpdateHandler [virtual], iArrayReadOnly< T > [virtual], iArrayReadOnly< csCollisionPair > [virtual], iArrayReadOnly< csGradientShade > [virtual], iArrayReadOnly< csRef< iCollection > > [virtual], iArrayReadOnly< csShaderVariable * > [virtual], iArrayReadOnly< csSprite2DVertex > [virtual], iArrayReadOnly< csVector3 > [virtual], iArrayReadOnly< iSceneNode * > [virtual], iBaseHalo [virtual], iBezierFactoryState [virtual], iBezierState [virtual], iBinaryLoaderPlugin [virtual], iBinarySaverPlugin [virtual], iBodyGroup [virtual], iBugPlug [virtual], iBugPlugRenderObject [virtual], iBulletDynamicSystem [virtual], iCacheManager [virtual], iCamera [virtual], iCameraPosition [virtual], iCameraPositionList [virtual], iCameraSectorListener [virtual], iCEGUI [virtual], iClipper2D [virtual], iColladaConvertor [virtual], iCollection [virtual], iCollider [virtual], iCollideSystem [virtual], iCommandLineParser [virtual], iComponent [virtual], iConfigFile [virtual], iConfigIterator [virtual], iConsoleExecCallback [virtual], iConsoleInput [virtual], iConsoleOutput [virtual], iConsoleWatcher [virtual], iCrossHalo [virtual], iCursor [virtual], iCurve [virtual], iDataBuffer [virtual], iDebugHelper [virtual], iDecalManager [virtual], iDecalTemplate [virtual], iDocument [virtual], iDocumentAttribute [virtual], iDocumentAttributeIterator [virtual], iDocumentNode [virtual], iDocumentNodeIterator [virtual], iDocumentSystem [virtual], iDynamics [virtual], iDynamicsColliderCollisionCallback [virtual], iDynamicsCollisionCallback [virtual], iDynamicsMoveCallback [virtual], iDynamicsStepCallback [virtual], iDynamicsSystemCollider [virtual], iDynamicSystem [virtual], iEmitFactoryState [virtual], iEmitGen3D [virtual], iEmitState [virtual], iEngine [virtual], iEngineFrameCallback [virtual], iEngineSectorCallback [virtual], iEngineSequenceManager [virtual], iEngineSequenceParameters [virtual], iEvent [virtual], iEventAttributeIterator [virtual], iEventCord [virtual], iEventHandler [virtual], iEventHandlerRegistry [virtual], iEventNameRegistry [virtual], iEventOutlet [virtual], iEventPlug [virtual], iEventQueue [virtual], iEventTimer [virtual], iFactory, iFile [virtual], iFireTexture [virtual], iFlareHalo [virtual], iFont [virtual], iFontDeleteNotify [virtual], iFontServer [virtual], iFrustumView [virtual], iFrustumViewUserdata [virtual], iGeneralMeshCommonState [virtual], iGeneralMeshSubMesh [virtual], iGenericRenderStep [virtual], iGenMeshAnimationControl [virtual], iGenMeshAnimationControl1_4 [virtual], iGenMeshAnimationControlFactory [virtual], iGenMeshAnimationControlState [virtual], iGenMeshAnimationControlType [virtual], iGenMeshSkeletonControlState [virtual], iGradient [virtual], iGraphics2D [virtual], iGraphics3D [virtual], iGraphicsMemory [virtual], iHalo [virtual], iHazeFactoryState [virtual], iHazeHull [virtual], iHazeHullBox [virtual], iHazeHullCone [virtual], iHazeHullCreation [virtual], iImage [virtual], iImageFileLoader [virtual], iImageIO [virtual], iImposter [virtual], iInputBinder [virtual], iInstancingMeshCommonState [virtual], iJob [virtual], iJobQueue [virtual], iJoint [virtual], iJoystickDriver [virtual], iKDTreeObjectDescriptor [virtual], iKDTreeUserData [virtual], iKeyboardDriver [virtual], iKeyComposer [virtual], iKeyValuePair [virtual], iKitchenSink [virtual], iLibraryReference [virtual], iLight [virtual], iLightCallback [virtual], iLightingInfo [virtual], iLightingManager, iLightingProcessData [virtual], iLightIterator [virtual], iLightIterRenderStep [virtual], iLightList [virtual], iLightManager [virtual], iLightningFactoryState [virtual], iLightRenderStep [virtual], iLightSectorInfluence [virtual], iLightVisibleCallback [virtual], iLoader [virtual], iLoaderContext [virtual], iLoaderContextCollection [virtual], iLoaderPlugin [virtual], iLODControl [virtual], iMapNode [virtual], iMaterialEngine [virtual], iMaterialList [virtual], iMaterialWrapper [virtual], iMemoryTracker [virtual], iMeshDrawCallback [virtual], iMeshFactoryList [virtual], iMeshFactoryWrapper [virtual], iMeshGenerator [virtual], iMeshGeneratorGeometry [virtual], iMeshList [virtual], iMeshObject [virtual], iMeshObjectDrawCallback [virtual], iMeshObjectFactory [virtual], iMeshObjectType [virtual], iMeshWrapper [virtual], iMeshWrapperIterator [virtual], iMissingLoaderData [virtual], iModelLoader [virtual], iMouseDriver [virtual], iMovable [virtual], iMovableListener [virtual], iMovieRecorder [virtual], iNativeWindow [virtual], iNativeWindowManager [virtual], iNovaHalo [virtual], iNullMeshState [virtual], iObject [virtual], iObjectIterator [virtual], iObjectModel [virtual], iObjectModelListener [virtual], iObjectNameChangeListener [virtual], iObjectRegistry [virtual], iObjectRegistryIterator [virtual], iObjectWatcher [virtual], iObjectWatcherListener [virtual], iODEBallJoint [virtual], iODEDynamicState [virtual], iODEDynamicSystemState [virtual], iODEFrameUpdateCallback [virtual], iODEGeneralJointState [virtual], iODEJointState [virtual], iOffscreenCanvasCallback [virtual], iOpenGLDriverDatabase [virtual], iOpenGLInterface [virtual], iOSXAssistant [virtual], iPagingFormerState [virtual], iParameterESM [virtual], iParticle [virtual], iParticleBuiltinEffectorFactory [virtual], iParticleBuiltinEmitterFactory [virtual], iParticleEffector [virtual], iParticleEmitter [virtual], iParticleState [virtual], iParticleSystemBase [virtual], iPath [virtual], iPluginConfig [virtual], iPluginIterator [virtual], iPluginManager [virtual], iPluginReference [virtual], iPolygonHandle [virtual], iPortal [virtual], iPortalCallback [virtual], iPortalContainer [virtual], iProcTexCallback [virtual], iProcTexture [virtual], iProfiler [virtual], iProfilerFactory [virtual], iProgressMeter [virtual], iProtoFactoryState [virtual], iProtoMeshState [virtual], iRefTracker [virtual], iRegion [virtual], iRegionList [virtual], iRenderBuffer [virtual], iRenderBufferAccessor [virtual], iRenderBufferCallback [virtual], iRenderBufferPersistence [virtual], iRendererLightmap [virtual], iRenderLoopManager [virtual], iRenderStep [virtual], iRenderStepContainer [virtual], iRenderStepFactory [virtual], iRenderStepType [virtual], iRenderView [virtual], iReporter [virtual], iReporterIterator [virtual], iReporterListener [virtual], iRigidBody [virtual], iSaver [virtual], iSaverFile [virtual], iSaverPlugin [virtual], iSceneNode [virtual], iSCF [virtual], iScript [virtual], iScriptObject [virtual], iScriptValue [virtual], iSector [virtual], iSectorCallback [virtual], iSectorIterator [virtual], iSectorList [virtual], iSectorMeshCallback [virtual], iSelfDestruct [virtual], iSequence [virtual], iSequenceCondition [virtual], iSequenceManager [virtual], iSequenceOperation [virtual], iSequenceTimedOperation [virtual], iSequenceTrigger [virtual], iSequenceWrapper [virtual], iShaderCompiler [virtual], iShaderDestinationResolver [virtual], iShaderPriorityList [virtual], iShaderProgram [virtual], iShaderProgramPlugin [virtual], iShaderVariableAccessor [virtual], iShaderVariableContext [virtual], iShadowBlock [virtual], iShadowBlockList [virtual], iShadowCaster [virtual], iShadowIterator [virtual], iShadowReceiver [virtual], iSharedVariable [virtual], iSharedVariableList [virtual], iSharedVariableListener [virtual], iSimpleFormerState [virtual], iSkeleton [virtual], iSkeleton2 [virtual], iSkeletonAnimation [virtual], iSkeletonAnimation2 [virtual], iSkeletonAnimationCallback [virtual], iSkeletonAnimationInstance [virtual], iSkeletonAnimationKeyFrame [virtual], iSkeletonAnimCallback2 [virtual], iSkeletonAnimNode2 [virtual], iSkeletonAnimNodeFactory2 [virtual], iSkeletonAnimPacket2 [virtual], iSkeletonAnimPacketFactory2 [virtual], iSkeletonBone [virtual], iSkeletonBoneFactory [virtual], iSkeletonBoneRagdollInfo [virtual], iSkeletonBoneUpdateCallback [virtual], iSkeletonFactory [virtual], iSkeletonFactory2 [virtual], iSkeletonGraveyard [virtual], iSkeletonManager2 [virtual], iSkeletonSocket [virtual], iSkeletonSocketFactory [virtual], iSkeletonUpdateCallback [virtual], iSndSysData [virtual], iSndSysEventRecorder [virtual], iSndSysListener [virtual], iSndSysListenerDoppler [virtual], iSndSysLoader [virtual], iSndSysManager [virtual], iSndSysRenderer [virtual], iSndSysRendererCallback [virtual], iSndSysRendererOpenAL [virtual], iSndSysRendererSoftware [virtual], iSndSysSoftwareDriver [virtual], iSndSysSoftwareFilter3D [virtual], iSndSysSoftwareOutputFilter [virtual], iSndSysSource [virtual], iSndSysSource3D [virtual], iSndSysSource3DDirectional [virtual], iSndSysSource3DDirectionalSimple [virtual], iSndSysSource3DDoppler [virtual], iSndSysSourceOpenAL [virtual], iSndSysStream [virtual], iSndSysStreamCallback [virtual], iSndSysWrapper [virtual], iSprite2DFactoryState [virtual], iSprite2DUVAnimation [virtual], iSprite2DUVAnimationFrame [virtual], iSprite3DFactoryState [virtual], iSprite3DState [virtual], iSpriteAction [virtual], iSpriteCal3DFactoryState [virtual], iSpriteCal3DState [virtual], iSpriteFrame [virtual], iSpriteSocket [virtual], iStandardReporterListener [virtual], iStreamDataCallback [virtual], iStreamSource [virtual], iString [virtual], iStringArray [virtual], iStringSet [virtual], iSuperLightmap [virtual], iSyntaxService [virtual], iSystemOpenManager [virtual], iTerraFormer [virtual], iTerrainCell [virtual], iTerrainCellCollisionProperties [virtual], iTerrainCellFeederProperties [virtual], iTerrainCellHeightDataCallback [virtual], iTerrainCellLoadCallback [virtual], iTerrainCollider [virtual], iTerrainDataFeeder [virtual], iTerrainFactory [virtual], iTerrainFactoryCell [virtual], iTerrainFactoryState [virtual], iTerrainObjectState [virtual], iTerrainRenderer [virtual], iTerrainSystem [virtual], iTerraSampler [virtual], iTextureCallback [virtual], iTextureFactory [virtual], iTextureHandle [virtual], iTextureList [virtual], iTextureLoaderContext [virtual], iTextureManager [virtual], iTextureType [virtual], iTextureWrapper [virtual], iThingEnvironment [virtual], iThingFactoryState [virtual], iThingState [virtual], iTimerEvent [virtual], iTranslator [virtual], iTriangleMesh [virtual], iTriangleMeshIterator [virtual], iUserRenderBufferIterator [virtual], iVerbosityManager [virtual], iVFS [virtual], iView [virtual], iVirtualClock [virtual], iVisibilityCuller [virtual], iVisibilityCullerListener [virtual], iVisibilityObject [virtual], iVisibilityObjectIterator [virtual], iWin32Assistant [virtual], iWin32Canvas [virtual], iWxWindow [virtual], iXWindow [virtual], scfImplementation< Class > [virtual], scfImplementation< csBaseRenderStepLoader > [virtual], scfImplementation< csBaseRenderStepType > [virtual], scfImplementation< csBaseTextureFactory > [virtual], scfImplementation< csClipper > [virtual], scfImplementation< csCommandLineParser > [virtual], scfImplementation< csCommonImageFileLoader > [virtual], scfImplementation< csConfigDocument > [virtual], scfImplementation< csConfigFile > [virtual], scfImplementation< csConfigManager > [virtual], scfImplementation< csDocumentAttributeCommon > [virtual], scfImplementation< csDocumentNodeCommon > [virtual], scfImplementation< csEmptyDocumentAttributeIterator > [virtual], scfImplementation< csEmptyDocumentNodeIterator > [virtual], scfImplementation< csEvent > [virtual], scfImplementation< csEventAttributeIterator > [virtual], scfImplementation< csEventCord > [virtual], scfImplementation< csEventHandlerRegistry > [virtual], scfImplementation< csEventNameRegistry > [virtual], scfImplementation< csEventOutlet > [virtual], scfImplementation< csEventQueue > [virtual], scfImplementation< csEventTimer > [virtual], scfImplementation< csGradient > [virtual], scfImplementation< csGraphics2D > [virtual], scfImplementation< csImageBase > [virtual], scfImplementation< csInputBinder > [virtual], scfImplementation< csJoystickDriver > [virtual], scfImplementation< csKDTree > [virtual], scfImplementation< csKeyboardDriver > [virtual], scfImplementation< csKeyComposer > [virtual], scfImplementation< csMemFile > [virtual], scfImplementation< csMeshFactory > [virtual], scfImplementation< csMeshType > [virtual], scfImplementation< csMouseDriver > [virtual], scfImplementation< csNormalizationCubeAccessor > [virtual], scfImplementation< csNullCacheManager > [virtual], scfImplementation< csObject > [virtual], scfImplementation< csObjectModel > [virtual], scfImplementation< csObjectRegistry > [virtual], scfImplementation< csParasiticDataBufferBase > [virtual], scfImplementation< csPhysicalFile > [virtual], scfImplementation< csPluginManager > [virtual], scfImplementation< csRenderBuffer > [virtual], scfImplementation< csScfStringSet > [virtual], scfImplementation< csScriptCommon > [virtual], scfImplementation< csScriptObjectCommon > [virtual], scfImplementation< csShaderProgram > [virtual], scfImplementation< csShaderVariableContext > [virtual], scfImplementation< csTextProgressMeter > [virtual], scfImplementation< csTextureHandle > [virtual], scfImplementation< csTextureManager > [virtual], scfImplementation< csTiledCoverageBuffer > [virtual], scfImplementation< csTinyDocumentSystem > [virtual], scfImplementation< csTriangleMesh > [virtual], scfImplementation< csTriangleMeshBox > [virtual], scfImplementation< csTriangleMeshPointer > [virtual], scfImplementation< csVerbosityManager > [virtual], scfImplementation< csVfsCacheManager > [virtual], scfImplementation< csView > [virtual], scfImplementation< csVirtualClock > [virtual], scfImplementation< csWin32RegistryConfig > [virtual], scfImplementation< DataBuffer< Allocator > > [virtual], scfImplementation< EventHandlerImpl > [virtual], scfImplementation< FilterDocumentNodeIterator< T > > [virtual], scfImplementation< FinalProcessFrameEventDispatcher > [virtual], scfImplementation< FontDeleteNotify > [virtual], scfImplementation< FrameBegin3DDraw > [virtual], scfImplementation< FramePrinter > [virtual], scfImplementation< FrameSignpost_2DConsole > [virtual], scfImplementation< FrameSignpost_3D2D > [virtual], scfImplementation< FrameSignpost_ConsoleDebug > [virtual], scfImplementation< FrameSignpost_DebugFrame > [virtual], scfImplementation< FrameSignpost_Logic3D > [virtual], scfImplementation< LoaderJob > [virtual], scfImplementation< PostProcessFrameEventDispatcher > [virtual], scfImplementation< PreProcessFrameEventDispatcher > [virtual], scfImplementation< ProcessFrameEventDispatcher > [virtual], scfImplementation< RenderBufferPersistent > [virtual], scfImplementation< scfArray< IF, Backend > > [virtual], scfImplementation< scfArrayWrap< IF, Backend > > [virtual], scfImplementation< scfArrayWrapConst< IF, Backend > > [virtual], scfImplementation< scfArrayWrapConst< iGradientShades, csArray< csGradientShade > > > [virtual], scfImplementation< scfString > [virtual], scfImplementation< scfStringArray > [virtual], scfImplementation< SimpleJobQueue > [virtual], scfImplementation< SndSysBasicData > [virtual], scfImplementation< SndSysBasicStream > [virtual], scfImplementation< SystemOpenManager > [virtual], and scfImplementation< ThreadedJobQueue > [virtual].

List of all members.

Public Member Functions

virtual void AddRefOwner (void **ref_owner)=0
 For weak references: add a reference owner.
virtual void DecRef ()=0
 Decrement the number of references to this object.
virtual scfInterfaceMetadataListGetInterfaceMetadata ()=0
 Request the meta-data for the interfaces implemented by this object.
virtual int GetRefCount ()=0
 Get the ref count (only for debugging).
virtual void IncRef ()=0
 Increment the number of references to this object.
virtual void * QueryInterface (scfInterfaceID iInterfaceID, int iVersion)=0
 Query a particular interface implemented by this object.
virtual void RemoveRefOwner (void **ref_owner)=0
 For weak references: remove a reference owner.

Protected Member Functions

virtual ~iBase ()
 Needed for GCC4.

Detailed Description

This is the basic interface: all other interfaces should be derived from this one, this will allow us to always use at least some minimal functionality given any interface pointer.

Definition at line 134 of file scf_interface.h.


Constructor & Destructor Documentation

virtual iBase::~iBase (  )  [inline, protected, virtual]

Needed for GCC4.

Otherwise emits a flood of "virtual functions but non-virtual destructor" warnings.

Definition at line 141 of file scf_interface.h.


Member Function Documentation

virtual void iBase::AddRefOwner ( void **  ref_owner  )  [pure virtual]

For weak references: add a reference owner.

Thread-safe - it is possible to add reference owners from different threads at the same time. However, if an object may be destructed on another thread, race conditions might ensue. If weak references are to be used in a multithreaded environment each thread holding a weak reference to an object should also hold a normal reference somewhere.

virtual void iBase::DecRef (  )  [pure virtual]

Decrement the number of references to this object.

Thread-safe - it is possible to manipulate the reference count from different threads. If multiple threads simultaneously decrement the reference count and cause the object to be freed it's not defined on which thread the subsequent destruction happens - it may happen in any one of the decrementing thread.

virtual scfInterfaceMetadataList* iBase::GetInterfaceMetadata (  )  [pure virtual]

Request the meta-data for the interfaces implemented by this object.

Thread-safe - it is possible to query the supported interfaces from different threads at the same time.

virtual int iBase::GetRefCount (  )  [pure virtual]

Get the ref count (only for debugging).

If another thread manipulates the reference count at the same time the count may reflect the state before or after the manipulation; it is undefined which exactly.

virtual void iBase::IncRef (  )  [pure virtual]

Increment the number of references to this object.

Thread-safe - it is possible to manipulate the reference count from different threads at the same time.

virtual void* iBase::QueryInterface ( scfInterfaceID  iInterfaceID,
int  iVersion 
) [pure virtual]

Query a particular interface implemented by this object.

You are _not_ allowed to cast this to anything but a pointer to this interface (not even iBase). Use scfQueryInterface<interface> instead of using this method directly. Thread-safe - it is possible to query interfaces from different threads at the same time.

virtual void iBase::RemoveRefOwner ( void **  ref_owner  )  [pure virtual]

For weak references: remove a reference owner.

Thread-safe - it is possible to add reference owners from different threads at the same time. But the see comments in AddRefOwner() on weak references in a multithreaded environment.


The documentation for this struct was generated from the following file:

Generated for Crystal Space 1.4.1 by doxygen 1.7.1