Class XRamExtension

The X-Ram Extension is provided on the top-end Sound Blaster X-Fi solutions (Sound Blaster X-Fi Fatal1ty, Sound Blaster X-Fi Elite Pro, or later). These products feature 64MB of X-Ram that can only be used for audio purposes, which can be controlled by this Extension.

Inheritance

Object

XRamExtension

Inherited Members

Object.ToString()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace: OpenTK.Audio.OpenAL

Assembly: OpenTK.dll

Syntax

[CLSCompliant(true)]
public sealed class XRamExtension

Constructors

XRamExtension()

Constructs a new XRamExtension instance.

Declaration

public XRamExtension()

Properties

GetRamFree

Query free X-RAM available in bytes.

Declaration

public int GetRamFree { get; }

Property Value

Type	Description
Int32

GetRamSize

Query total amount of X-RAM in bytes.

Declaration

public int GetRamSize { get; }

Property Value

Type	Description
Int32

IsInitialized

Returns True if the X-Ram Extension has been found and could be initialized.

Declaration

public bool IsInitialized { get; }

Property Value

Type	Description
Boolean

Methods

GetBufferMode(ref Int32)

This function is used to retrieve the storage Mode of a single OpenAL Buffer.

Declaration

[CLSCompliant(true)]
public XRamExtension.XRamStorage GetBufferMode(ref int buffer)

Parameters

Type	Name	Description
Int32	buffer	The handle of an OpenAL Buffer.

Returns

Type	Description
XRamExtension.XRamStorage	The current Mode of the Buffer.

GetBufferMode(ref UInt32)

This function is used to retrieve the storage Mode of a single OpenAL Buffer.

Declaration

[CLSCompliant(false)]
public XRamExtension.XRamStorage GetBufferMode(ref uint buffer)

Parameters

Type	Name	Description
UInt32	buffer	The handle of an OpenAL Buffer.

Returns

Type	Description
XRamExtension.XRamStorage	The current Mode of the Buffer.

SetBufferMode(Int32, ref Int32, XRamExtension.XRamStorage)

This function is used to set the storage Mode of an array of OpenAL Buffers.

Declaration

[CLSCompliant(true)]
public bool SetBufferMode(int n, ref int buffer, XRamExtension.XRamStorage mode)

Parameters

Type	Name	Description
Int32	n	The number of OpenAL Buffers pointed to by buffer.
Int32	buffer	An array of OpenAL Buffer handles.
XRamExtension.XRamStorage	mode	The storage mode that should be used for all the given buffers. Should be the value of one of the following enum names: XRamStorage.Automatic, XRamStorage.Hardware, XRamStorage.Accessible

Returns

Type	Description
Boolean	True if all the Buffers were successfully set to the requested storage mode, False otherwise.

SetBufferMode(Int32, ref UInt32, XRamExtension.XRamStorage)

This function is used to set the storage Mode of an array of OpenAL Buffers.

Declaration

[CLSCompliant(false)]
public bool SetBufferMode(int n, ref uint buffer, XRamExtension.XRamStorage mode)

Parameters

Type	Name	Description
Int32	n	The number of OpenAL Buffers pointed to by buffer.
UInt32	buffer	An array of OpenAL Buffer handles.
XRamExtension.XRamStorage	mode	The storage mode that should be used for all the given buffers. Should be the value of one of the following enum names: XRamStorage.Automatic, XRamStorage.Hardware, XRamStorage.Accessible

Returns

Type	Description
Boolean	True if all the Buffers were successfully set to the requested storage mode, False otherwise.