Lighweight Java Game Library 2.9.3 · org.lwjgl.openal.ALCdevice

public final Class ALCdevice

The ALCdevice class represents a device opened in OpenAL space. ALC introduces the notion of a Device. A Device can be, depending on the implementation, a hardware device, or a daemon/OS service/actual server. This mechanism also permits different drivers (and hardware) to coexist within the same system, as well as allowing several applications to share system resources for audio, including a single hardware output device. The details are left to the implementation, which has to map the available backends to unique device specifiers.

Author

Brian Matzon

Version

$Revision$ $Id$

Field Summary

Modifier and Type	Field and Description
private final HashMap<Long, ALCcontext>	contexts List of contexts belonging to the device
pack-priv final long	device Address of actual device
private boolean	valid Whether this device is valid

Constructor Summary

Access	Constructor and Description
pack-priv	ALCdevice(long address of actual device device) Creates a new instance of ALCdevice

Method Summary

Modifier and Type	Method and Description
pack-priv void	addContext(ALCcontext context to add to the list of contexts for this device context) Adds a context to the device
public boolean	equals(Object the reference object with which to compare. device) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public boolean	Returns: true if this device is still valid isValid()
pack-priv void	removeContext(ALCcontext Context to disassociate with device context) Remove context associated with device
pack-priv void	setInvalid() Marks this device and all of its contexts invalid

Inherited from java.lang.Object:: clone finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

contexts	back to summary
private final HashMap<Long, ALCcontext> contexts List of contexts belonging to the device

device	back to summary
pack-priv final long device Address of actual device

valid	back to summary
private boolean valid Whether this device is valid

Constructor Detail

ALCdevice	back to summary
pack-priv ALCdevice(long device) Creates a new instance of ALCdevice Parameters device:long address of actual device

ALCdevice

back to summary

pack-priv ALCdevice(long device)

Creates a new instance of ALCdevice

Parameters

device:long: address of actual device

Method Detail

addContext	back to summary
pack-priv void addContext(ALCcontext context) Adds a context to the device Parameters context:ALCcontext context to add to the list of contexts for this device

addContext

back to summary

pack-priv void addContext(ALCcontext context)

Adds a context to the device

Parameters

context:ALCcontext: context to add to the list of contexts for this device

equals back to summary

equals	back to summary
public boolean equals(Object device) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters device:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise.

public boolean equals(Object device)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

device:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

isValid	back to summary
public boolean isValid() Returns:boolean true if this device is still valid

removeContext	back to summary
pack-priv void removeContext(ALCcontext context) Remove context associated with device Parameters context:ALCcontext Context to disassociate with device

removeContext

back to summary

pack-priv void removeContext(ALCcontext context)

Remove context associated with device

Parameters

context:ALCcontext: Context to disassociate with device

setInvalid	back to summary
pack-priv void setInvalid() Marks this device and all of its contexts invalid

public final Class ALCdevice

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail