PLSound::Resource Class Reference

Sound resource. More...

#include <Resource.h>

Inheritance diagram for PLSound::Resource:

List of all members.

Public Types
enum	EType { TypeBuffer = 0, TypeSource = 1 }
	Resource type. More...
Public Member Functions
virtual PLSOUND_API	~Resource ()
	Destructor.
PLSOUND_API SoundManager &	GetSoundManager () const
	Returns the owner sound manager.
PLSOUND_API EType	GetType () const
	Returns the resource type.
PLSOUND_API PLCore::uint32	GetNumOfResourceHandlers () const
	Returns the number of resource handlers.
PLSOUND_API bool	IsResourceHandler (ResourceHandler &cHandler) const
	Returns whether a resource handler is using this resource.
PLSOUND_API bool	AddResourceHandler (ResourceHandler &cHandler)
	Adds a resource handler.
PLSOUND_API bool	RemoveResourceHandler (ResourceHandler &cHandler)
	Removes a resource handler.
PLSOUND_API void	ClearResourceHandlers ()
	Clears the list of handlers.
Protected Member Functions
PLSOUND_API	Resource (SoundManager &cSoundManager, EType nType)
	Constructor.

---

Detailed Description

Sound resource.

---

Member Enumeration Documentation

enum PLSound::Resource::EType

Resource type.

Enumerator:

TypeBuffer	Sound buffer
TypeSource	Sound source

---

Constructor & Destructor Documentation

virtual PLSOUND_API PLSound::Resource::~Resource

(

)

[virtual]

Destructor.

PLSOUND_API PLSound::Resource::Resource	(	SoundManager &	cSoundManager,
		EType	nType
	)		[protected]

Constructor.

Parameters:

[in]	cSoundManager	Owner sound manager
[in]	nType	Resource type

---

Member Function Documentation

PLSOUND_API SoundManager& PLSound::Resource::GetSoundManager

(

)

const

Returns the owner sound manager.

Returns:

The owner sound manager

PLSOUND_API EType PLSound::Resource::GetType

(

)

const

Returns the resource type.

Returns:

Resource type

PLSOUND_API PLCore::uint32 PLSound::Resource::GetNumOfResourceHandlers

(

)

const

Returns the number of resource handlers.

Returns:

The number of resource handlers

PLSOUND_API bool PLSound::Resource::IsResourceHandler

(

ResourceHandler &

cHandler

)

const

Returns whether a resource handler is using this resource.

Parameters:

[in]

cHandler

Resource handler to check

Returns:

'true' if the given resource handler is using this resource, else 'false'

Note:

• The handlers will be informed if the resource was lost
• The handlers itself are not deleted etc. they are only 'added' to a list

PLSOUND_API bool PLSound::Resource::AddResourceHandler

(

ResourceHandler &

cHandler

)

Adds a resource handler.

Parameters:

[in]

cHandler

Resource handler which should be added

Returns:

'true' if all went fine, else 'false'

See also:

• IsHandler()

PLSOUND_API bool PLSound::Resource::RemoveResourceHandler

(

ResourceHandler &

cHandler

)

Removes a resource handler.

Parameters:

[in]

cHandler

Resource handler to remove

Returns:

'true' if all went fine, else 'false'

See also:

• IsHandler()

PLSOUND_API void PLSound::Resource::ClearResourceHandlers

(

)

Clears the list of handlers.

See also:

• IsHandler()

---

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

• PLSound/include/PLSound/Resource.h