<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd"> <html><head><title>File Loading - ALURE</title><link rel="stylesheet" type="text/css" href="../styles/main.css"><script language=JavaScript src="../javascript/main.js"></script></head><body class=UnframedPage onLoad="NDOnLoad()"><script language=JavaScript><!-- if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script> <!-- Generated by Natural Docs, version 1.35 --> <!-- http://www.naturaldocs.org --> <!-- saved from url=(0026)http://www.naturaldocs.org --> <table border=0 cellspacing=0 cellpadding=0 width=100%><tr><td class=MenuSection valign=top><!--START_ND_MENU--><div class=MTitle>ALURE<div class=MSubTitle>API Reference</div></div><div class=MEntry><div class=MFile><a href="alure-cpp.html">Main and Miscellanious</a></div></div><div class=MEntry><div class=MFile id=MSelected>File Loading</div></div><div class=MEntry><div class=MFile><a href="stream-cpp.html">Streaming</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent1')">Index</a><div class=MGroupContent id=MGroupContent1><div class=MEntry><div class=MIndex><a href="../index/General.html">Everything</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Functions.html">Functions</a></div></div></div></div></div><!--END_ND_MENU--></td> <td class=ContentSection valign=top><div class=CSection id=MainTopic><div class=CTopic><h1 class=CTitle><a name="File_Loading"></a>File Loading</h1><div class=CBody><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr><td class=SEntrySize><div class=SMain><div class=SEntry><a href="#File_Loading" >File Loading</a></div></div></td><td class=SDescriptionSize><div class=SMain><div class=SDescription></div></div></td></tr><tr><td><div class=SGroup><div class=SEntry><div class=SIndent1><a href="#Functions" >Functions</a></div></div></div></td><td><div class=SGroup><div class=SDescription><div class=SIndent1></div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#alureCreateBufferFromFile" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">alureCreateBufferFromFile</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>Loads the given file into a new OpenAL buffer object. </div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#alureCreateBufferFromMemory" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">alureCreateBufferFromMemory</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>Loads a file image from memory into a new OpenAL buffer object, similar to alureCreateBufferFromFile. </div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#alureBufferDataFromFile" id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">alureBufferDataFromFile</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>Loads the given file into an existing OpenAL buffer object. </div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#alureBufferDataFromMemory" id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')">alureBufferDataFromMemory</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>Loads a file image from memory into an existing OpenAL buffer object, similar to alureBufferDataFromFile. </div></div></div></td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div> <div class=CGroup><div class=CTopic><h3 class=CTitle><a name="Functions"></a>Functions</h3></div></div> <div class=CFunction><div class=CTopic><h3 class=CTitle><a name="alureCreateBufferFromFile"></a>alureCreateBufferFromFile</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>ALURE_API ALuint ALURE_APIENTRY alureCreateBufferFromFile(</td><td class=PTypePrefix nowrap>const </td><td class=PType nowrap>ALchar </td><td class=PParameterPrefix nowrap>*</td><td class=PParameter nowrap>fname</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p class=CParagraph>Loads the given file into a new OpenAL buffer object. The formats supported depend on the options the library was compiled with, what libraries are available at runtime, and the installed decode callbacks. Requires an active context.</p><h4 class=CHeading>Returns</h4><p class=CParagraph>A new buffer ID with the loaded sound, or AL_NONE on error.</p><h4 class=CHeading>See Also</h4><p class=CParagraph><a href="#alureCreateBufferFromMemory" class=LFunction id=link5 onMouseOver="ShowTip(event, 'tt2', 'link5')" onMouseOut="HideTip('tt2')">alureCreateBufferFromMemory</a>, <a href="#alureBufferDataFromFile" class=LFunction id=link6 onMouseOver="ShowTip(event, 'tt3', 'link6')" onMouseOut="HideTip('tt3')">alureBufferDataFromFile</a></p></div></div></div> <div class=CFunction><div class=CTopic><h3 class=CTitle><a name="alureCreateBufferFromMemory"></a>alureCreateBufferFromMemory</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters colspan=5>ALURE_API ALuint ALURE_APIENTRY alureCreateBufferFromMemory(</td></tr><tr><td> </td><td class=PTypePrefix nowrap>const </td><td class=PType nowrap>ALubyte </td><td class=PParameterPrefix nowrap>*</td><td class=PParameter nowrap width=100%>fdata,</td></tr><tr><td> </td><td class=PTypePrefix nowrap></td><td class=PType nowrap>ALsizei </td><td class=PParameterPrefix nowrap></td><td class=PParameter nowrap width=100%>length</td></tr><tr><td class=PAfterParameters colspan=5>)</td></tr></table></td></tr></table></blockquote><p class=CParagraph>Loads a file image from memory into a new OpenAL buffer object, similar to alureCreateBufferFromFile. Requires an active context.</p><h4 class=CHeading>Returns</h4><p class=CParagraph>A new buffer ID with the loaded sound, or AL_NONE on error.</p><h4 class=CHeading>See Also</h4><p class=CParagraph><a href="#alureCreateBufferFromFile" class=LFunction id=link7 onMouseOver="ShowTip(event, 'tt1', 'link7')" onMouseOut="HideTip('tt1')">alureCreateBufferFromFile</a>, <a href="#alureBufferDataFromMemory" class=LFunction id=link8 onMouseOver="ShowTip(event, 'tt4', 'link8')" onMouseOut="HideTip('tt4')">alureBufferDataFromMemory</a></p></div></div></div> <div class=CFunction><div class=CTopic><h3 class=CTitle><a name="alureBufferDataFromFile"></a>alureBufferDataFromFile</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters colspan=5>ALURE_API ALboolean ALURE_APIENTRY alureBufferDataFromFile(</td></tr><tr><td> </td><td class=PTypePrefix nowrap>const </td><td class=PType nowrap>ALchar </td><td class=PParameterPrefix nowrap>*</td><td class=PParameter nowrap width=100%>fname,</td></tr><tr><td> </td><td class=PTypePrefix nowrap></td><td class=PType nowrap>ALuint </td><td class=PParameterPrefix nowrap></td><td class=PParameter nowrap width=100%>buffer</td></tr><tr><td class=PAfterParameters colspan=5>)</td></tr></table></td></tr></table></blockquote><p class=CParagraph>Loads the given file into an existing OpenAL buffer object. The previous contents of the buffer are replaced. Requires an active context.</p><h4 class=CHeading>Returns</h4><p class=CParagraph>AL_FALSE on error.</p><h4 class=CHeading>See Also</h4><p class=CParagraph><a href="#alureCreateBufferFromFile" class=LFunction id=link9 onMouseOver="ShowTip(event, 'tt1', 'link9')" onMouseOut="HideTip('tt1')">alureCreateBufferFromFile</a>, <a href="#alureBufferDataFromMemory" class=LFunction id=link10 onMouseOver="ShowTip(event, 'tt4', 'link10')" onMouseOut="HideTip('tt4')">alureBufferDataFromMemory</a></p></div></div></div> <div class=CFunction><div class=CTopic><h3 class=CTitle><a name="alureBufferDataFromMemory"></a>alureBufferDataFromMemory</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters colspan=5>ALURE_API ALboolean ALURE_APIENTRY alureBufferDataFromMemory(</td></tr><tr><td> </td><td class=PTypePrefix nowrap>const </td><td class=PType nowrap>ALubyte </td><td class=PParameterPrefix nowrap>*</td><td class=PParameter nowrap width=100%>fdata,</td></tr><tr><td> </td><td class=PTypePrefix nowrap></td><td class=PType nowrap>ALsizei </td><td class=PParameterPrefix nowrap></td><td class=PParameter nowrap width=100%>length,</td></tr><tr><td> </td><td class=PTypePrefix nowrap></td><td class=PType nowrap>ALuint </td><td class=PParameterPrefix nowrap></td><td class=PParameter nowrap width=100%>buffer</td></tr><tr><td class=PAfterParameters colspan=5>)</td></tr></table></td></tr></table></blockquote><p class=CParagraph>Loads a file image from memory into an existing OpenAL buffer object, similar to alureBufferDataFromFile. Requires an active context.</p><h4 class=CHeading>Returns</h4><p class=CParagraph>AL_FALSE on error.</p><h4 class=CHeading>See Also</h4><p class=CParagraph><a href="#alureCreateBufferFromMemory" class=LFunction id=link11 onMouseOver="ShowTip(event, 'tt2', 'link11')" onMouseOut="HideTip('tt2')">alureCreateBufferFromMemory</a>, <a href="#alureBufferDataFromFile" class=LFunction id=link12 onMouseOver="ShowTip(event, 'tt3', 'link12')" onMouseOut="HideTip('tt3')">alureBufferDataFromFile</a></p></div></div></div> </td> </tr></table><div class=Footer><!--START_ND_FOOTER-->Generated by <a href="http://www.naturaldocs.org">Natural Docs</a><!--END_ND_FOOTER--></div> <!--START_ND_TOOLTIPS--> <div class=CToolTip id="tt1"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>ALURE_API ALuint ALURE_APIENTRY alureCreateBufferFromFile(</td><td class=PTypePrefix nowrap>const </td><td class=PType nowrap>ALchar </td><td class=PParameterPrefix nowrap>*</td><td class=PParameter nowrap>fname</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Loads the given file into a new OpenAL buffer object. </div></div><div class=CToolTip id="tt2"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters colspan=5>ALURE_API ALuint ALURE_APIENTRY alureCreateBufferFromMemory(</td></tr><tr><td> </td><td class=PTypePrefix nowrap>const </td><td class=PType nowrap>ALubyte </td><td class=PParameterPrefix nowrap>*</td><td class=PParameter nowrap width=100%>fdata,</td></tr><tr><td> </td><td class=PTypePrefix nowrap></td><td class=PType nowrap>ALsizei </td><td class=PParameterPrefix nowrap></td><td class=PParameter nowrap width=100%>length</td></tr><tr><td class=PAfterParameters colspan=5>)</td></tr></table></td></tr></table></blockquote>Loads a file image from memory into a new OpenAL buffer object, similar to alureCreateBufferFromFile. </div></div><div class=CToolTip id="tt3"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters colspan=5>ALURE_API ALboolean ALURE_APIENTRY alureBufferDataFromFile(</td></tr><tr><td> </td><td class=PTypePrefix nowrap>const </td><td class=PType nowrap>ALchar </td><td class=PParameterPrefix nowrap>*</td><td class=PParameter nowrap width=100%>fname,</td></tr><tr><td> </td><td class=PTypePrefix nowrap></td><td class=PType nowrap>ALuint </td><td class=PParameterPrefix nowrap></td><td class=PParameter nowrap width=100%>buffer</td></tr><tr><td class=PAfterParameters colspan=5>)</td></tr></table></td></tr></table></blockquote>Loads the given file into an existing OpenAL buffer object. </div></div><div class=CToolTip id="tt4"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters colspan=5>ALURE_API ALboolean ALURE_APIENTRY alureBufferDataFromMemory(</td></tr><tr><td> </td><td class=PTypePrefix nowrap>const </td><td class=PType nowrap>ALubyte </td><td class=PParameterPrefix nowrap>*</td><td class=PParameter nowrap width=100%>fdata,</td></tr><tr><td> </td><td class=PTypePrefix nowrap></td><td class=PType nowrap>ALsizei </td><td class=PParameterPrefix nowrap></td><td class=PParameter nowrap width=100%>length,</td></tr><tr><td> </td><td class=PTypePrefix nowrap></td><td class=PType nowrap>ALuint </td><td class=PParameterPrefix nowrap></td><td class=PParameter nowrap width=100%>buffer</td></tr><tr><td class=PAfterParameters colspan=5>)</td></tr></table></td></tr></table></blockquote>Loads a file image from memory into an existing OpenAL buffer object, similar to alureBufferDataFromFile. </div></div><!--END_ND_TOOLTIPS--> <script language=JavaScript><!-- if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>