woollybah hace 6 años
padre
commit
b15eb8311d

+ 2 - 2
docs/api/brl/brl.audio/tchannel.md

@@ -69,8 +69,8 @@ cause the audio channel to play at double speed (ie: an octave up).
 Determine whether audio channel is playing
 
 
-[Playing](../../brl/brl.audio/#method-playing-int) will return False if the audio channel is either paused, or has been stopped
-using [Stop](../../brl/brl.audio/#method-stop).
+[Playing](../../../brl/brl.audio/#method-playing-int) will return False if the audio channel is either paused, or has been stopped
+using [Stop](../../../brl/brl.audio/#method-stop).
 
 
 #### Returns

+ 5 - 5
docs/api/brl/brl.audio/tsound.md

@@ -13,7 +13,7 @@ Play the sound
 
 
 Starts a sound playing through an audio channel.
-If no channel is specified, [Play](../../brl/brl.audio/#method-play-tchannel-alloced-channel-tchannel-null) automatically allocates a channel for you.
+If no channel is specified, [Play](../../../brl/brl.audio/#method-play-tchannel-alloced-channel-tchannel-null) automatically allocates a channel for you.
 
 
 #### Returns
@@ -27,10 +27,10 @@ Cue the sound for playback
 
 
 Prepares an audio channel for playback of a sound.
-To actually start the sound, you must use the channel's [SetPaused](../../brl/brl.audio/#method-setpaused-paused-int) method.
-If no channel is specified, [Cue](../../brl/brl.audio/#method-cue-tchannel-alloced-channel-tchannel-null) automatically allocates a channel for you.
+To actually start the sound, you must use the channel's [SetPaused](../../../brl/brl.audio/#method-setpaused-paused-int) method.
+If no channel is specified, [Cue](../../../brl/brl.audio/#method-cue-tchannel-alloced-channel-tchannel-null) automatically allocates a channel for you.
 
-[Cue](../../brl/brl.audio/#method-cue-tchannel-alloced-channel-tchannel-null) allows you to setup various audio channel states such as volume, pan, depth and rate before a sound
+[Cue](../../../brl/brl.audio/#method-cue-tchannel-alloced-channel-tchannel-null) allows you to setup various audio channel states such as volume, pan, depth and rate before a sound
 actually starts playing.
 
 
@@ -47,7 +47,7 @@ Load sound
 
 
 <b>url</b> can be either a string, a stream or an audio sample object.
-The returned sound object can be played using [Play](../../brl/brl.audio/#method-play-tchannel-alloced-channel-tchannel-null) or [Cue](../../brl/brl.audio/#method-cue-tchannel-alloced-channel-tchannel-null).
+The returned sound object can be played using [Play](../../../brl/brl.audio/#method-play-tchannel-alloced-channel-tchannel-null) or [Cue](../../../brl/brl.audio/#method-cue-tchannel-alloced-channel-tchannel-null).
 
 
 #### Returns

+ 3 - 3
docs/api/brl/brl.bank/tbank.md

@@ -12,7 +12,7 @@ sidebar_label: TBank
 Get a bank's memory pointer
 
 
-Please use [Lock](../../brl/brl.bank/#method-lock-byte-ptr) and [Unlock](../../brl/brl.bank/#method-unlock) instead of this method.
+Please use [Lock](../../../brl/brl.bank/#method-lock-byte-ptr) and [Unlock](../../../brl/brl.bank/#method-unlock) instead of this method.
 
 
 #### Returns
@@ -27,7 +27,7 @@ Lock a bank's memory block
 
 While locked, a bank cannot be resized.
 
-After you have finished with a bank's memory block, you must use [Unlock](../../brl/brl.bank/#method-unlock)
+After you have finished with a bank's memory block, you must use [Unlock](../../../brl/brl.bank/#method-unlock)
 to return it to the bank.
 
 
@@ -41,7 +41,7 @@ A byte pointer to the memory block controlled by the bank
 Unlock a bank's memory pointer
 
 
-After you have finished with a bank's memory block, you must use [Unlock](../../brl/brl.bank/#method-unlock)
+After you have finished with a bank's memory block, you must use [Unlock](../../../brl/brl.bank/#method-unlock)
 to return it to the bank.
 
 

+ 1 - 1
docs/api/brl/brl.blitz/toutofdataexception.md

@@ -5,6 +5,6 @@ sidebar_label: TOutOfDataException
 ---
 
 
-Thrown when [ReadData](../../brl/brl.blitz/#readdata) is used but not enough data is left to read. (only in debug mode)
+Thrown when [ReadData](../../../brl/brl.blitz/#readdata) is used but not enough data is left to read. (only in debug mode)
 
 

+ 1 - 1
docs/api/brl/brl.blitz/truntimeexception.md

@@ -5,6 +5,6 @@ sidebar_label: TRuntimeException
 ---
 
 
-Thrown by [RuntimeError](../../brl/brl.blitz/#function-runtimeerror-message).
+Thrown by [RuntimeError](../../../brl/brl.blitz/#function-runtimeerror-message).
 
 

+ 1 - 1
docs/api/brl/brl.event/tevent.md

@@ -49,7 +49,7 @@ Event specific extra information
 Emit this event
 
 
-This method runs all [EmitEventHook](../../brl/brl.event/#global-emiteventhook-int-allochookid) hook function, passing <b>Self</b> as
+This method runs all [EmitEventHook](../../../brl/brl.event/#global-emiteventhook-int-allochookid) hook function, passing <b>Self</b> as
 the hook data.
 
 

+ 1 - 1
docs/api/brl/brl.maxlua/tluaclass.md

@@ -10,7 +10,7 @@ The TLuaClass type is used to contain lua source code.
 
 The source code should consist of a series of one or more lua functions.
 
-To actually invoke these functions a lua object must first be created - see [TLuaObject](../../brl/brl.maxlua/tluaobject).
+To actually invoke these functions a lua object must first be created - see [TLuaObject](../../../brl/brl.maxlua/tluaobject).
 
 
 ## Methods

+ 1 - 1
docs/api/brl/brl.maxlua/tluaobject.md

@@ -36,7 +36,7 @@ Create a lua object
 
 
 Once a lua object has been created, object methods (actually lua functions defined in the
-class) can be invoked using the [Invoke](../../brl/brl.maxlua/#method-invoke-object-name-args-object) method.
+class) can be invoked using the [Invoke](../../../brl/brl.maxlua/#method-invoke-object-name-args-object) method.
 
 
 

+ 2 - 2
docs/api/brl/brl.pixmap/tpixmaploader.md

@@ -6,9 +6,9 @@ sidebar_label: TPixmapLoader
 
 
 
-To create a new pixmap loader, you should extend TPixmapLoader and implement the [LoadPixmap](../../brl/brl.pixmap/#method-loadpixmap-tpixmap-stream-tstream-abstract) method.
+To create a new pixmap loader, you should extend TPixmapLoader and implement the [LoadPixmap](../../../brl/brl.pixmap/#method-loadpixmap-tpixmap-stream-tstream-abstract) method.
 
-To install your pixmap loader, simply create an instance of it using [New](../../brl/brl.blitz/#new)</font>.
+To install your pixmap loader, simply create an instance of it using [New](../../../brl/brl.blitz/#new)</font>.
 
 
 ## Methods

+ 21 - 21
docs/api/brl/brl.stream/tstream.md

@@ -6,7 +6,7 @@ sidebar_label: TStream
 
 
 
-[TStream](../../brl/brl.stream/tstream) extends [TIO](../../brl/brl.stream/tio) to provide methods for reading and writing various types of values
+[TStream](../../../brl/brl.stream/tstream) extends [TIO](../../../brl/brl.stream/tio) to provide methods for reading and writing various types of values
 to and from a stream.
 
 Note that methods dealing with strings - ReadLine, WriteLine, ReadString and WriteString -
@@ -21,9 +21,9 @@ TextStream type will be added capable of decoding text streams in multiple forma
 Reads bytes from a stream
 
 
-[ReadBytes](../../brl/brl.stream/#method-readbytes-long-buf-byte-ptr-count-long) reads <b>count</b> bytes from the stream into the memory block specified by <b>buf</b>.
+[ReadBytes](../../../brl/brl.stream/#method-readbytes-long-buf-byte-ptr-count-long) reads <b>count</b> bytes from the stream into the memory block specified by <b>buf</b>.
 
-If <b>count</b> bytes were not successfully read, a [TStreamReadException](../../brl/brl.stream/tstreamreadexception) is thrown. This typically
+If <b>count</b> bytes were not successfully read, a [TStreamReadException](../../../brl/brl.stream/tstreamreadexception) is thrown. This typically
 occurs due to end of file.
 
 
@@ -33,9 +33,9 @@ occurs due to end of file.
 Writes bytes to a stream
 
 
-[WriteBytes](../../brl/brl.stream/#method-writebytes-long-buf-byte-ptr-count-long) writes <b>count</b> bytes from the memory block specified by <b>buf</b> to the stream.
+[WriteBytes](../../../brl/brl.stream/#method-writebytes-long-buf-byte-ptr-count-long) writes <b>count</b> bytes from the memory block specified by <b>buf</b> to the stream.
 
-If <b>count</b> bytes were not successfully written, a [TStreamWriteException](../../brl/brl.stream/tstreamwriteexception) is thrown. This typically
+If <b>count</b> bytes were not successfully written, a [TStreamWriteException](../../../brl/brl.stream/tstreamwriteexception) is thrown. This typically
 occurs due to end of file.
 
 
@@ -45,9 +45,9 @@ occurs due to end of file.
 Skip bytes in a stream
 
 
-[SkipBytes](../../brl/brl.stream/#method-skipbytes-long-count-long) read <b>count</b> bytes from the stream and throws them away.
+[SkipBytes](../../../brl/brl.stream/#method-skipbytes-long-count-long) read <b>count</b> bytes from the stream and throws them away.
 
-If <b>count</b> bytes were not successfully read, a [TStreamReadException](../../brl/brl.stream/tstreamreadexception) is thrown. This typically
+If <b>count</b> bytes were not successfully read, a [TStreamReadException](../../../brl/brl.stream/tstreamreadexception) is thrown. This typically
 occurs due to end of file.
 
 
@@ -57,7 +57,7 @@ occurs due to end of file.
 Read a byte from the stream
 
 
-If a value could not be read (possibly due to end of file), a [TStreamReadException](../../brl/brl.stream/tstreamreadexception) is thrown.
+If a value could not be read (possibly due to end of file), a [TStreamReadException](../../../brl/brl.stream/tstreamreadexception) is thrown.
 
 
 #### Returns
@@ -70,7 +70,7 @@ The read value
 Write a byte to the stream
 
 
-If the value could not be written (possibly due to end of file), a [TStreamWriteException](../../brl/brl.stream/tstreamwriteexception) is thrown.
+If the value could not be written (possibly due to end of file), a [TStreamWriteException](../../../brl/brl.stream/tstreamwriteexception) is thrown.
 
 
 
@@ -79,7 +79,7 @@ If the value could not be written (possibly due to end of file), a [TStreamWrite
 Read a short (two bytes) from the stream
 
 
-If a value could not be read (possibly due to end of file), a [TStreamReadException](../../brl/brl.stream/tstreamreadexception) is thrown.
+If a value could not be read (possibly due to end of file), a [TStreamReadException](../../../brl/brl.stream/tstreamreadexception) is thrown.
 
 
 #### Returns
@@ -92,7 +92,7 @@ The read value
 Write a short (two bytes) to the stream
 
 
-If the value could not be written (possibly due to end of file), a [TStreamWriteException](../../brl/brl.stream/tstreamwriteexception) is thrown.
+If the value could not be written (possibly due to end of file), a [TStreamWriteException](../../../brl/brl.stream/tstreamwriteexception) is thrown.
 
 
 
@@ -101,7 +101,7 @@ If the value could not be written (possibly due to end of file), a [TStreamWrite
 Read an int (four bytes) from the stream
 
 
-If a value could not be read (possibly due to end of file), a [TStreamReadException](../../brl/brl.stream/tstreamreadexception) is thrown.
+If a value could not be read (possibly due to end of file), a [TStreamReadException](../../../brl/brl.stream/tstreamreadexception) is thrown.
 
 
 #### Returns
@@ -114,7 +114,7 @@ The read value
 Write an int (four bytes) to the stream
 
 
-If the value could not be written (possibly due to end of file), a [TStreamWriteException](../../brl/brl.stream/tstreamwriteexception) is thrown.
+If the value could not be written (possibly due to end of file), a [TStreamWriteException](../../../brl/brl.stream/tstreamwriteexception) is thrown.
 
 
 
@@ -123,7 +123,7 @@ If the value could not be written (possibly due to end of file), a [TStreamWrite
 Read a long (eight bytes) from the stream
 
 
-If a value could not be read (possibly due to end of file), a [TStreamReadException](../../brl/brl.stream/tstreamreadexception) is thrown.
+If a value could not be read (possibly due to end of file), a [TStreamReadException](../../../brl/brl.stream/tstreamreadexception) is thrown.
 
 
 #### Returns
@@ -136,7 +136,7 @@ The read value
 Write a long (eight bytes) to the stream
 
 
-If the value could not be written (possibly due to end of file), a [TStreamWriteException](../../brl/brl.stream/tstreamwriteexception) is thrown.
+If the value could not be written (possibly due to end of file), a [TStreamWriteException](../../../brl/brl.stream/tstreamwriteexception) is thrown.
 
 
 
@@ -145,7 +145,7 @@ If the value could not be written (possibly due to end of file), a [TStreamWrite
 Read a float (four bytes) from the stream
 
 
-If a value could not be read (possibly due to end of file), a [TStreamReadException](../../brl/brl.stream/tstreamreadexception) is thrown.
+If a value could not be read (possibly due to end of file), a [TStreamReadException](../../../brl/brl.stream/tstreamreadexception) is thrown.
 
 
 #### Returns
@@ -158,7 +158,7 @@ The read value
 Write a float (four bytes) to the stream
 
 
-If the value could not be written (possibly due to end of file), a [TStreamWriteException](../../brl/brl.stream/tstreamwriteexception) is thrown.
+If the value could not be written (possibly due to end of file), a [TStreamWriteException](../../../brl/brl.stream/tstreamwriteexception) is thrown.
 
 
 
@@ -167,7 +167,7 @@ If the value could not be written (possibly due to end of file), a [TStreamWrite
 Read a double (eight bytes) from the stream
 
 
-If a value could not be read (possibly due to end of file), a [TStreamReadException](../../brl/brl.stream/tstreamreadexception) is thrown.
+If a value could not be read (possibly due to end of file), a [TStreamReadException](../../../brl/brl.stream/tstreamreadexception) is thrown.
 
 
 #### Returns
@@ -180,7 +180,7 @@ The read value
 Write a double (eight bytes) to the stream
 
 
-If the value could not be written (possibly due to end of file), a [TStreamWriteException](../../brl/brl.stream/tstreamwriteexception) is thrown.
+If the value could not be written (possibly due to end of file), a [TStreamWriteException](../../../brl/brl.stream/tstreamwriteexception) is thrown.
 
 
 
@@ -217,7 +217,7 @@ True if line successfully written, else False
 Read characters from the stream
 
 
-A [TStreamReadException](../../brl/brl.stream/tstreamreadexception) is thrown if not all bytes could be read.
+A [TStreamReadException](../../../brl/brl.stream/tstreamreadexception) is thrown if not all bytes could be read.
 
 
 #### Returns
@@ -230,7 +230,7 @@ A string composed of <b>length</b> bytes read from the stream
 Write characters to the stream
 
 
-A [TStreamWriteException](../../brl/brl.stream/tstreamwriteexception) is thrown if not all bytes could be written.
+A [TStreamWriteException](../../../brl/brl.stream/tstreamwriteexception) is thrown if not all bytes could be written.
 
 
 

+ 3 - 3
docs/api/brl/brl.stream/tstreamfactory.md

@@ -6,7 +6,7 @@ sidebar_label: TStreamFactory
 
 
 
-Stream factories are used by the [OpenStream](../../brl/brl.stream/#function-openstream-tstream-url-object-readable-int-true-writeable-int-true), [ReadStream](../../brl/brl.stream/#function-readstream-tstream-url-object) and [WriteStream](../../brl/brl.stream/#function-writestream-tstream-url-object) functions
+Stream factories are used by the [OpenStream](../../../brl/brl.stream/#function-openstream-tstream-url-object-readable-int-true-writeable-int-true), [ReadStream](../../../brl/brl.stream/#function-readstream-tstream-url-object) and [WriteStream](../../../brl/brl.stream/#function-writestream-tstream-url-object) functions
 to create streams based on a 'url object'.
 
 Url objects are usually strings, in which case the url is divided into 2 parts - a
@@ -27,8 +27,8 @@ Create a stream based on a url object
 
 Types which extends TStreamFactory must implement this method.
 
-<b>url</b> contains the original url object as supplied to [OpenStream](../../brl/brl.stream/#function-openstream-tstream-url-object-readable-int-true-writeable-int-true), [ReadStream](../../brl/brl.stream/#function-readstream-tstream-url-object) or
-[WriteStream](../../brl/brl.stream/#function-writestream-tstream-url-object).
+<b>url</b> contains the original url object as supplied to [OpenStream](../../../brl/brl.stream/#function-openstream-tstream-url-object-readable-int-true-writeable-int-true), [ReadStream](../../../brl/brl.stream/#function-readstream-tstream-url-object) or
+[WriteStream](../../../brl/brl.stream/#function-writestream-tstream-url-object).
 
 If <b>url</b> is a string, <b>proto</b> contains the url protocol - for example, the "incbin" part
 of "incbin::myfile".

+ 2 - 2
docs/api/brl/brl.stream/tstreamreadexception.md

@@ -6,8 +6,8 @@ sidebar_label: TStreamReadException
 
 
 
-[TStreamReadException](../../brl/brl.stream/tstreamreadexception) is usually thrown when a stream operation failed to read enough
+[TStreamReadException](../../../brl/brl.stream/tstreamreadexception) is usually thrown when a stream operation failed to read enough
 bytes. For example, if the stream ReadInt method fails to read 4 bytes, it will throw
-a [TStreamReadException](../../brl/brl.stream/tstreamreadexception).
+a [TStreamReadException](../../../brl/brl.stream/tstreamreadexception).
 
 

+ 1 - 1
docs/api/brl/brl.stream/tstreamwrapper.md

@@ -6,7 +6,7 @@ sidebar_label: TStreamWrapper
 
 
 
-[TStreamWrapper](../../brl/brl.stream/tstreamwrapper) 'wraps' an existing stream, redirecting all TIO method calls to the wrapped
+[TStreamWrapper](../../../brl/brl.stream/tstreamwrapper) 'wraps' an existing stream, redirecting all TIO method calls to the wrapped
 stream.
 
 This can be useful for writing stream 'filters' that modify the behaviour of existing

+ 2 - 2
docs/api/brl/brl.stream/tstreamwriteexception.md

@@ -6,8 +6,8 @@ sidebar_label: TStreamWriteException
 
 
 
-[TStreamWriteException](../../brl/brl.stream/tstreamwriteexception) is usually thrown when a stream operation failed to write enough
+[TStreamWriteException](../../../brl/brl.stream/tstreamwriteexception) is usually thrown when a stream operation failed to write enough
 bytes. For example, if the stream WriteInt method fails to write 4 bytes, it will throw
-a [TStreamWriteException](../../brl/brl.stream/tstreamwriteexception).
+a [TStreamWriteException](../../../brl/brl.stream/tstreamwriteexception).
 
 

+ 1 - 1
docs/api/brl/brl.stringbuilder/tstringbuilder.md

@@ -78,7 +78,7 @@ Appends a Long value to the string builder.
 
 Appends the new line string to the string builder.
 
-The new line string can be altered using [SetNewLineText](../../brl/brl.stringbuilder/#method-setnewlinetext-tstringbuilder-newline-string). This might be used to force the output to always use Unix line endings even when on Windows.
+The new line string can be altered using [SetNewLineText](../../../brl/brl.stringbuilder/#method-setnewlinetext-tstringbuilder-newline-string). This might be used to force the output to always use Unix line endings even when on Windows.
 
 
 

+ 1 - 1
docs/api/brl/brl.threads/tmutex.md

@@ -22,7 +22,7 @@ Lock the mutex
 Try to lock the mutex
 
 #### Returns
-[True](../../brl/brl.blitz/#true) if mutex was successfully locked; [False](../../brl/brl.blitz/#false) if mutex was already locked by another thread.
+[True](../../../brl/brl.blitz/#true) if mutex was successfully locked; [False](../../../brl/brl.blitz/#false) if mutex was already locked by another thread.
 
 
 

+ 8 - 0
docs/api/maxgui/maxgui_maxgui.md

@@ -3318,3 +3318,11 @@ Return internal gadget handle.
 
 
 
+### `Function GadgetScaleFactor:Int( gadget:TGadget )`
+
+Returns the gadget scale factor that maps from window coordiantes to the actual device pixels.
+
+On traditional systems this is 1, but on very high density outputs this can be a higher value (often 2).
+
+
+

+ 2 - 2
docs/api/pub/pub.joystick/tjoystickdriver.md

@@ -6,8 +6,8 @@ sidebar_label: TJoystickDriver
 
 
 
-To create a new pixmap loader, you should extend TPixmapLoader and implement the [LoadPixmap](../../brl/brl.pixmap/#method-loadpixmap-tpixmap-stream-tstream-abstract) method.
+To create a new pixmap loader, you should extend TPixmapLoader and implement the [LoadPixmap](../../../brl/brl.pixmap/#method-loadpixmap-tpixmap-stream-tstream-abstract) method.
 
-To install your pixmap loader, simply create an instance of it using [New](../../brl/brl.blitz/#new)</font>.
+To install your pixmap loader, simply create an instance of it using [New](../../../brl/brl.blitz/#new)</font>.