diff --git a/flixel/addons/text/TypeSound.html b/flixel/addons/text/TypeSound.html index 22ab59569f..805444624a 100644 --- a/flixel/addons/text/TypeSound.html +++ b/flixel/addons/text/TypeSound.html @@ -39,9 +39,7 @@ (content installed with the AIR application) are not restricted by these security limitations.

For more information related to security, see the Flash Player -Developer Center Topic: <a -href="http://www.adobe.com/go/devnet_security_en" -scope="external">Security.

read onlyisBuffering:Bool

Returns the buffering state of external MP3 files. If the value is +Developer Center Topic: Security.

read onlyisBuffering:Bool

Returns the buffering state of external MP3 files. If the value is true, any playback is currently suspended while the object waits for more data.

read onlylength:Float

The length of the current sound in milliseconds.

read onlysampleRate:Int

read onlyurl:String

The URL from which this sound was loaded. This property is applicable only to Sound objects that were loaded using the Sound.load() diff --git a/flixel/addons/transition/GraphicTransTileCircle.html b/flixel/addons/transition/GraphicTransTileCircle.html index 9f1c4996ce..b4bc0d3659 100644 --- a/flixel/addons/transition/GraphicTransTileCircle.html +++ b/flixel/addons/transition/GraphicTransTileCircle.html @@ -53,19 +53,16 @@ upper-left corner of the rectangular area where the new channel data is placed. To copy only channel data from one area to a different area in -the destination image, specify a point other than

-
				   (0,0).
-
sourceChannel

The source channel. Use a value from the -BitmapDataChannel class

-
				   (`BitmapDataChannel.RED`,
-
-

BitmapDataChannel.BLUE, +the destination image, specify a point other than +(0,0).

sourceChannel

The source channel. Use a value from the +BitmapDataChannel class +(BitmapDataChannel.RED, +BitmapDataChannel.BLUE, BitmapDataChannel.GREEN, BitmapDataChannel.ALPHA).

destChannel

The destination channel. Use a value from the -BitmapDataChannel class

-
				   (`BitmapDataChannel.RED`,
-
-

BitmapDataChannel.BLUE, +BitmapDataChannel class +(BitmapDataChannel.RED, +BitmapDataChannel.BLUE, BitmapDataChannel.GREEN, BitmapDataChannel.ALPHA).

Throws:

TypeError

The sourceBitmapData, sourceRect or destPoint are null.

See also:

@:value({ mergeAlpha : false, alphaPoint : null, alphaBitmapData : null })copyPixels(sourceBitmapData:BitmapData, sourceRect:Rectangle, destPoint:Point, ?alphaBitmapData:BitmapData, ?alphaPoint:Point, mergeAlpha:Bool = false):Void

Provides a fast routine to perform pixel manipulation between images with no stretching, rotation, or color effects. This method copies a @@ -351,10 +348,10 @@ considered opaque in the second BitmapData object. Use this parameter only when the value of secondObject is a BitmapData object and both BitmapData objects are transparent.

Returns:

A value of true if a hit occurs; otherwise, false.

Throws:

ArgumentError

The secondObject parameter is not a Point, Rectangle, -Bitmap, or BitmapData object.

TypeError

The firstPoint is null.

lock():Void

When targeting AIR, this method locks an image so that any objects -that reference the BitmapData object, such as Bitmap objects, are not -updated when this BitmapData object changes. To improve performance, -use this method along with the unlock() method before and after numerous +Bitmap, or BitmapData object.

TypeError

The firstPoint is null.

lock():Void

When targeting AIR, this method locks an image so that any objects +that reference the BitmapData object, such as Bitmap objects, are not +updated when this BitmapData object changes. To improve performance, +use this method along with the unlock() method before and after numerous calls to the setPixel() or setPixel32() method.

Note: This method only provides an optimization on the AIR(Flash) target. For all other targets, this method contains an empty function body.

merge(sourceBitmapData:BitmapData, sourceRect:Rectangle, destPoint:Point, redMultiplier:UInt, greenMultiplier:UInt, blueMultiplier:UInt, alphaMultiplier:UInt):Void

Performs per-channel blending from a source image to a destination image. For @@ -544,8 +541,8 @@ destination when the threshold test fails. If the value is false, the source image is not copied when the threshold test fails.

Returns:

The number of pixels that were changed.

Throws:

ArgumentError

The operation string is not a valid operation

TypeError

The sourceBitmapData, sourceRect destPoint or -operation are null.

@:value({ changeRect : null })unlock(?changeRect:Rectangle):Void

When targeting AIR, this method Unlocks an image so that any objects that reference -the BitmapData object, such as Bitmap objects, are updated when this BitmapData object +operation are null.

@:value({ changeRect : null })unlock(?changeRect:Rectangle):Void

When targeting AIR, this method Unlocks an image so that any objects that reference +the BitmapData object, such as Bitmap objects, are updated when this BitmapData object changes.

To improve performance, use this method along with the lock() method before and after numerous calls to the setPixel() or diff --git a/flixel/addons/transition/GraphicTransTileDiamond.html b/flixel/addons/transition/GraphicTransTileDiamond.html index 87fb3c32f5..ac63514eac 100644 --- a/flixel/addons/transition/GraphicTransTileDiamond.html +++ b/flixel/addons/transition/GraphicTransTileDiamond.html @@ -53,19 +53,16 @@ upper-left corner of the rectangular area where the new channel data is placed. To copy only channel data from one area to a different area in -the destination image, specify a point other than

-
				   (0,0).
-
sourceChannel

The source channel. Use a value from the -BitmapDataChannel class

-
				   (`BitmapDataChannel.RED`,
-
-

BitmapDataChannel.BLUE, +the destination image, specify a point other than +(0,0).

sourceChannel

The source channel. Use a value from the +BitmapDataChannel class +(BitmapDataChannel.RED, +BitmapDataChannel.BLUE, BitmapDataChannel.GREEN, BitmapDataChannel.ALPHA).

destChannel

The destination channel. Use a value from the -BitmapDataChannel class

-
				   (`BitmapDataChannel.RED`,
-
-

BitmapDataChannel.BLUE, +BitmapDataChannel class +(BitmapDataChannel.RED, +BitmapDataChannel.BLUE, BitmapDataChannel.GREEN, BitmapDataChannel.ALPHA).

Throws:

TypeError

The sourceBitmapData, sourceRect or destPoint are null.

See also:

@:value({ mergeAlpha : false, alphaPoint : null, alphaBitmapData : null })copyPixels(sourceBitmapData:BitmapData, sourceRect:Rectangle, destPoint:Point, ?alphaBitmapData:BitmapData, ?alphaPoint:Point, mergeAlpha:Bool = false):Void

Provides a fast routine to perform pixel manipulation between images with no stretching, rotation, or color effects. This method copies a @@ -351,10 +348,10 @@ considered opaque in the second BitmapData object. Use this parameter only when the value of secondObject is a BitmapData object and both BitmapData objects are transparent.

Returns:

A value of true if a hit occurs; otherwise, false.

Throws:

ArgumentError

The secondObject parameter is not a Point, Rectangle, -Bitmap, or BitmapData object.

TypeError

The firstPoint is null.

lock():Void

When targeting AIR, this method locks an image so that any objects -that reference the BitmapData object, such as Bitmap objects, are not -updated when this BitmapData object changes. To improve performance, -use this method along with the unlock() method before and after numerous +Bitmap, or BitmapData object.

TypeError

The firstPoint is null.

lock():Void

When targeting AIR, this method locks an image so that any objects +that reference the BitmapData object, such as Bitmap objects, are not +updated when this BitmapData object changes. To improve performance, +use this method along with the unlock() method before and after numerous calls to the setPixel() or setPixel32() method.

Note: This method only provides an optimization on the AIR(Flash) target. For all other targets, this method contains an empty function body.

merge(sourceBitmapData:BitmapData, sourceRect:Rectangle, destPoint:Point, redMultiplier:UInt, greenMultiplier:UInt, blueMultiplier:UInt, alphaMultiplier:UInt):Void

Performs per-channel blending from a source image to a destination image. For @@ -544,8 +541,8 @@ destination when the threshold test fails. If the value is false, the source image is not copied when the threshold test fails.

Returns:

The number of pixels that were changed.

Throws:

ArgumentError

The operation string is not a valid operation

TypeError

The sourceBitmapData, sourceRect destPoint or -operation are null.

@:value({ changeRect : null })unlock(?changeRect:Rectangle):Void

When targeting AIR, this method Unlocks an image so that any objects that reference -the BitmapData object, such as Bitmap objects, are updated when this BitmapData object +operation are null.

@:value({ changeRect : null })unlock(?changeRect:Rectangle):Void

When targeting AIR, this method Unlocks an image so that any objects that reference +the BitmapData object, such as Bitmap objects, are updated when this BitmapData object changes.

To improve performance, use this method along with the lock() method before and after numerous calls to the setPixel() or diff --git a/flixel/addons/transition/GraphicTransTileSquare.html b/flixel/addons/transition/GraphicTransTileSquare.html index 99160d8b37..7385452d02 100644 --- a/flixel/addons/transition/GraphicTransTileSquare.html +++ b/flixel/addons/transition/GraphicTransTileSquare.html @@ -53,19 +53,16 @@ upper-left corner of the rectangular area where the new channel data is placed. To copy only channel data from one area to a different area in -the destination image, specify a point other than

-
				   (0,0).
-
sourceChannel

The source channel. Use a value from the -BitmapDataChannel class

-
				   (`BitmapDataChannel.RED`,
-
-

BitmapDataChannel.BLUE, +the destination image, specify a point other than +(0,0).

sourceChannel

The source channel. Use a value from the +BitmapDataChannel class +(BitmapDataChannel.RED, +BitmapDataChannel.BLUE, BitmapDataChannel.GREEN, BitmapDataChannel.ALPHA).

destChannel

The destination channel. Use a value from the -BitmapDataChannel class

-
				   (`BitmapDataChannel.RED`,
-
-

BitmapDataChannel.BLUE, +BitmapDataChannel class +(BitmapDataChannel.RED, +BitmapDataChannel.BLUE, BitmapDataChannel.GREEN, BitmapDataChannel.ALPHA).

Throws:

TypeError

The sourceBitmapData, sourceRect or destPoint are null.

See also:

@:value({ mergeAlpha : false, alphaPoint : null, alphaBitmapData : null })copyPixels(sourceBitmapData:BitmapData, sourceRect:Rectangle, destPoint:Point, ?alphaBitmapData:BitmapData, ?alphaPoint:Point, mergeAlpha:Bool = false):Void

Provides a fast routine to perform pixel manipulation between images with no stretching, rotation, or color effects. This method copies a @@ -351,10 +348,10 @@ considered opaque in the second BitmapData object. Use this parameter only when the value of secondObject is a BitmapData object and both BitmapData objects are transparent.

Returns:

A value of true if a hit occurs; otherwise, false.

Throws:

ArgumentError

The secondObject parameter is not a Point, Rectangle, -Bitmap, or BitmapData object.

TypeError

The firstPoint is null.

lock():Void

When targeting AIR, this method locks an image so that any objects -that reference the BitmapData object, such as Bitmap objects, are not -updated when this BitmapData object changes. To improve performance, -use this method along with the unlock() method before and after numerous +Bitmap, or BitmapData object.

TypeError

The firstPoint is null.

lock():Void

When targeting AIR, this method locks an image so that any objects +that reference the BitmapData object, such as Bitmap objects, are not +updated when this BitmapData object changes. To improve performance, +use this method along with the unlock() method before and after numerous calls to the setPixel() or setPixel32() method.

Note: This method only provides an optimization on the AIR(Flash) target. For all other targets, this method contains an empty function body.

merge(sourceBitmapData:BitmapData, sourceRect:Rectangle, destPoint:Point, redMultiplier:UInt, greenMultiplier:UInt, blueMultiplier:UInt, alphaMultiplier:UInt):Void

Performs per-channel blending from a source image to a destination image. For @@ -544,8 +541,8 @@ destination when the threshold test fails. If the value is false, the source image is not copied when the threshold test fails.

Returns:

The number of pixels that were changed.

Throws:

ArgumentError

The operation string is not a valid operation

TypeError

The sourceBitmapData, sourceRect destPoint or -operation are null.

@:value({ changeRect : null })unlock(?changeRect:Rectangle):Void

When targeting AIR, this method Unlocks an image so that any objects that reference -the BitmapData object, such as Bitmap objects, are updated when this BitmapData object +operation are null.

@:value({ changeRect : null })unlock(?changeRect:Rectangle):Void

When targeting AIR, this method Unlocks an image so that any objects that reference +the BitmapData object, such as Bitmap objects, are updated when this BitmapData object changes.

To improve performance, use this method along with the lock() method before and after numerous calls to the setPixel() or diff --git a/flixel/sound/FlxSound.html b/flixel/sound/FlxSound.html index 7e0cebe7c2..a3b84504ce 100644 --- a/flixel/sound/FlxSound.html +++ b/flixel/sound/FlxSound.html @@ -15,7 +15,8 @@ If set while paused, changes only come into effect after a resume() call.

volume:Float

Set volume to a value between 0 and 1 to change how this sound is.

x:Float

The x position of this sound in world coordinates. Only really matters if you are doing proximity/panning stuff.

y:Float

The y position of this sound in world coordinates. Only really matters if you are doing proximity/panning stuff.

onComplete:() ‑> Void

Tracker for sound complete callback. If assigned, will be called -each time when sound reaches its end.

Methods

@:value({ To : 1, From : 0, Duration : 1 })inlinefadeIn(Duration:Float = 1, From:Float = 0, To:Float = 1, ?onComplete:FlxTween ‑> Void):FlxSound

Helper function that tweens this sound's volume.

Parameters:

Duration

The amount of time the fade-in operation should take.

From

The volume to tween from, 0 by default.

To

The volume to tween to, 1 by default.

@:value({ To : 0, Duration : 1 })inlinefadeOut(Duration:Float = 1, To:Float = 0, ?onComplete:FlxTween ‑> Void):FlxSound

Helper function that tweens this sound's volume.

Parameters:

Duration

The amount of time the fade-out operation should take.

To

The volume to tween to, 0 by default.

inlinegetActualVolume():Float

Returns the currently selected "real" volume of the sound (takes fades and proximity into account).

Returns:

The adjusted volume of the sound.

@:value({ AutoDestroy : false, Looped : false })loadEmbedded(EmbeddedSound:FlxSoundAsset, Looped:Bool = false, AutoDestroy:Bool = false, ?OnComplete:() ‑> Void):FlxSound

One of the main setup functions for sounds, this function loads a sound from an embedded MP3.

Parameters:

EmbeddedSound

An embedded Class object representing an MP3 file.

Looped

Whether or not this sound should loop endlessly.

AutoDestroy

Whether or not this FlxSound instance should be destroyed when the sound finishes playing. +each time when sound reaches its end.

Methods

@:value({ To : 1, From : 0, Duration : 1 })inlinefadeIn(Duration:Float = 1, From:Float = 0, To:Float = 1, ?onComplete:FlxTween ‑> Void):FlxSound

Helper function that tweens this sound's volume.

Parameters:

Duration

The amount of time the fade-in operation should take.

From

The volume to tween from, 0 by default.

To

The volume to tween to, 1 by default.

@:value({ To : 0, Duration : 1 })inlinefadeOut(Duration:Float = 1, To:Float = 0, ?onComplete:FlxTween ‑> Void):FlxSound

Helper function that tweens this sound's volume.

Parameters:

Duration

The amount of time the fade-out operation should take.

To

The volume to tween to, 0 by default.

inlinegetActualVolume():Float

Returns the currently selected "real" volume of the sound (takes fades and proximity into account).

Returns:

The adjusted volume of the sound.

@:value({ AutoDestroy : false, Looped : false })loadEmbedded(EmbeddedSound:FlxSoundAsset, Looped:Bool = false, AutoDestroy:Bool = false, ?OnComplete:() ‑> Void):FlxSound

One of the main setup functions for sounds, this function loads a sound from an embedded MP3.

+

Note: If the FLX_DEFAULT_SOUND_EXT flag is enabled, you may omit the file extension

Parameters:

EmbeddedSound

An embedded Class object representing an MP3 file.

Looped

Whether or not this sound should loop endlessly.

AutoDestroy

Whether or not this FlxSound instance should be destroyed when the sound finishes playing. Default value is false, but FlxG.sound.play() and FlxG.sound.stream() will set it to true by default.

OnComplete

Called when the sound finished playing

Returns:

This FlxSound instance (nice for chaining stuff together, if you're into that).

@:value({ AutoDestroy : false, Looped : false })loadStream(SoundURL:String, Looped:Bool = false, AutoDestroy:Bool = false, ?OnComplete:() ‑> Void, ?OnLoad:() ‑> Void):FlxSound

One of the main setup functions for sounds, this function loads a sound from a URL.

Parameters:

SoundURL

A string representing the URL of the MP3 file you want to play.

Looped

Whether or not this sound should loop endlessly.

AutoDestroy

Whether or not this FlxSound instance should be destroyed when the sound finishes playing. Default value is false, but FlxG.sound.play() and FlxG.sound.stream() will set it to true by default.

OnComplete

Called when the sound finished playing

OnLoad

Called when the sound finished loading.

Returns:

This FlxSound instance (nice for chaining stuff together, if you're into that).

pause():FlxSound

Call this function to pause this sound.

@:value({ StartTime : 0.0, ForceRestart : false })play(ForceRestart:Bool = false, StartTime:Float = 0.0, ?EndTime:Float):FlxSound

Call this function to play the sound - also works on paused sounds.

Parameters:

ForceRestart

Whether to start the sound over or not. Default value is false, meaning if the sound is already playing or was diff --git a/flixel/system/FlxVersion.html b/flixel/system/FlxVersion.html index 13d5b646ac..218702d420 100644 --- a/flixel/system/FlxVersion.html +++ b/flixel/system/FlxVersion.html @@ -7,6 +7,6 @@ float: none; text-shadow: 0 0 0 transparent; } -

class FlxVersion

package flixel.system

@:directlyUsed@:build(hscript.macros.UsingHandler.build())@:build(hscript.macros.ClassExtendMacro.build())@:build(flixel.system.macros.FlxGitSHA.buildGitSHA("flixel"))

Helper object for semantic versioning.

See also:

Static variables

@:value("34655345c0dd05353aee3d610d90a5b4cecae239\n")staticread onlysha:Dynamic = "34655345c0dd05353aee3d610d90a5b4cecae239\n"

Constructor

new(Major:Int, Minor:Int, Patch:Int)

Variables

read onlymajor:Int

read onlyminor:Int

read onlypatch:Int

Methods

toString():String

Formats the version in the format "HaxeFlixel MAJOR.MINOR.PATCH-COMMIT_SHA", +

class FlxVersion

package flixel.system

@:directlyUsed@:build(hscript.macros.UsingHandler.build())@:build(hscript.macros.ClassExtendMacro.build())@:build(flixel.system.macros.FlxGitSHA.buildGitSHA("flixel"))

Helper object for semantic versioning.

See also:

Static variables

@:value("3560c23c02aa568d9cc6bc338194b4c135ed76f7\n")staticread onlysha:Dynamic = "3560c23c02aa568d9cc6bc338194b4c135ed76f7\n"

Constructor

new(Major:Int, Minor:Int, Patch:Int)

Variables

read onlymajor:Int

read onlyminor:Int

read onlypatch:Int

Methods

toString():String

Formats the version in the format "HaxeFlixel MAJOR.MINOR.PATCH-COMMIT_SHA", e.g. HaxeFlixel 3.0.4. If this is a dev version, the git sha is included.

© 2024  

\ No newline at end of file diff --git a/flixel/system/GraphicLogo.html b/flixel/system/GraphicLogo.html index 86cb35224c..22523346bc 100644 --- a/flixel/system/GraphicLogo.html +++ b/flixel/system/GraphicLogo.html @@ -53,19 +53,16 @@ upper-left corner of the rectangular area where the new channel data is placed. To copy only channel data from one area to a different area in -the destination image, specify a point other than

-
				   (0,0).
-
sourceChannel

The source channel. Use a value from the -BitmapDataChannel class

-
				   (`BitmapDataChannel.RED`,
-
-

BitmapDataChannel.BLUE, +the destination image, specify a point other than +(0,0).

sourceChannel

The source channel. Use a value from the +BitmapDataChannel class +(BitmapDataChannel.RED, +BitmapDataChannel.BLUE, BitmapDataChannel.GREEN, BitmapDataChannel.ALPHA).

destChannel

The destination channel. Use a value from the -BitmapDataChannel class

-
				   (`BitmapDataChannel.RED`,
-
-

BitmapDataChannel.BLUE, +BitmapDataChannel class +(BitmapDataChannel.RED, +BitmapDataChannel.BLUE, BitmapDataChannel.GREEN, BitmapDataChannel.ALPHA).

Throws:

TypeError

The sourceBitmapData, sourceRect or destPoint are null.

See also:

@:value({ mergeAlpha : false, alphaPoint : null, alphaBitmapData : null })copyPixels(sourceBitmapData:BitmapData, sourceRect:Rectangle, destPoint:Point, ?alphaBitmapData:BitmapData, ?alphaPoint:Point, mergeAlpha:Bool = false):Void

Provides a fast routine to perform pixel manipulation between images with no stretching, rotation, or color effects. This method copies a @@ -351,10 +348,10 @@ considered opaque in the second BitmapData object. Use this parameter only when the value of secondObject is a BitmapData object and both BitmapData objects are transparent.

Returns:

A value of true if a hit occurs; otherwise, false.

Throws:

ArgumentError

The secondObject parameter is not a Point, Rectangle, -Bitmap, or BitmapData object.

TypeError

The firstPoint is null.

lock():Void

When targeting AIR, this method locks an image so that any objects -that reference the BitmapData object, such as Bitmap objects, are not -updated when this BitmapData object changes. To improve performance, -use this method along with the unlock() method before and after numerous +Bitmap, or BitmapData object.

TypeError

The firstPoint is null.

lock():Void

When targeting AIR, this method locks an image so that any objects +that reference the BitmapData object, such as Bitmap objects, are not +updated when this BitmapData object changes. To improve performance, +use this method along with the unlock() method before and after numerous calls to the setPixel() or setPixel32() method.

Note: This method only provides an optimization on the AIR(Flash) target. For all other targets, this method contains an empty function body.

merge(sourceBitmapData:BitmapData, sourceRect:Rectangle, destPoint:Point, redMultiplier:UInt, greenMultiplier:UInt, blueMultiplier:UInt, alphaMultiplier:UInt):Void

Performs per-channel blending from a source image to a destination image. For @@ -544,8 +541,8 @@ destination when the threshold test fails. If the value is false, the source image is not copied when the threshold test fails.

Returns:

The number of pixels that were changed.

Throws:

ArgumentError

The operation string is not a valid operation

TypeError

The sourceBitmapData, sourceRect destPoint or -operation are null.

@:value({ changeRect : null })unlock(?changeRect:Rectangle):Void

When targeting AIR, this method Unlocks an image so that any objects that reference -the BitmapData object, such as Bitmap objects, are updated when this BitmapData object +operation are null.

@:value({ changeRect : null })unlock(?changeRect:Rectangle):Void

When targeting AIR, this method Unlocks an image so that any objects that reference +the BitmapData object, such as Bitmap objects, are updated when this BitmapData object changes.

To improve performance, use this method along with the lock() method before and after numerous calls to the setPixel() or diff --git a/flixel/system/GraphicVirtualInput.html b/flixel/system/GraphicVirtualInput.html index 4a9dbc799f..a891205941 100644 --- a/flixel/system/GraphicVirtualInput.html +++ b/flixel/system/GraphicVirtualInput.html @@ -53,19 +53,16 @@ upper-left corner of the rectangular area where the new channel data is placed. To copy only channel data from one area to a different area in -the destination image, specify a point other than

-
				   (0,0).
-
sourceChannel

The source channel. Use a value from the -BitmapDataChannel class

-
				   (`BitmapDataChannel.RED`,
-
-

BitmapDataChannel.BLUE, +the destination image, specify a point other than +(0,0).

sourceChannel

The source channel. Use a value from the +BitmapDataChannel class +(BitmapDataChannel.RED, +BitmapDataChannel.BLUE, BitmapDataChannel.GREEN, BitmapDataChannel.ALPHA).

destChannel

The destination channel. Use a value from the -BitmapDataChannel class

-
				   (`BitmapDataChannel.RED`,
-
-

BitmapDataChannel.BLUE, +BitmapDataChannel class +(BitmapDataChannel.RED, +BitmapDataChannel.BLUE, BitmapDataChannel.GREEN, BitmapDataChannel.ALPHA).

Throws:

TypeError

The sourceBitmapData, sourceRect or destPoint are null.

See also:

@:value({ mergeAlpha : false, alphaPoint : null, alphaBitmapData : null })copyPixels(sourceBitmapData:BitmapData, sourceRect:Rectangle, destPoint:Point, ?alphaBitmapData:BitmapData, ?alphaPoint:Point, mergeAlpha:Bool = false):Void

Provides a fast routine to perform pixel manipulation between images with no stretching, rotation, or color effects. This method copies a @@ -351,10 +348,10 @@ considered opaque in the second BitmapData object. Use this parameter only when the value of secondObject is a BitmapData object and both BitmapData objects are transparent.

Returns:

A value of true if a hit occurs; otherwise, false.

Throws:

ArgumentError

The secondObject parameter is not a Point, Rectangle, -Bitmap, or BitmapData object.

TypeError

The firstPoint is null.

lock():Void

When targeting AIR, this method locks an image so that any objects -that reference the BitmapData object, such as Bitmap objects, are not -updated when this BitmapData object changes. To improve performance, -use this method along with the unlock() method before and after numerous +Bitmap, or BitmapData object.

TypeError

The firstPoint is null.

lock():Void

When targeting AIR, this method locks an image so that any objects +that reference the BitmapData object, such as Bitmap objects, are not +updated when this BitmapData object changes. To improve performance, +use this method along with the unlock() method before and after numerous calls to the setPixel() or setPixel32() method.

Note: This method only provides an optimization on the AIR(Flash) target. For all other targets, this method contains an empty function body.

merge(sourceBitmapData:BitmapData, sourceRect:Rectangle, destPoint:Point, redMultiplier:UInt, greenMultiplier:UInt, blueMultiplier:UInt, alphaMultiplier:UInt):Void

Performs per-channel blending from a source image to a destination image. For @@ -544,8 +541,8 @@ destination when the threshold test fails. If the value is false, the source image is not copied when the threshold test fails.

Returns:

The number of pixels that were changed.

Throws:

ArgumentError

The operation string is not a valid operation

TypeError

The sourceBitmapData, sourceRect destPoint or -operation are null.

@:value({ changeRect : null })unlock(?changeRect:Rectangle):Void

When targeting AIR, this method Unlocks an image so that any objects that reference -the BitmapData object, such as Bitmap objects, are updated when this BitmapData object +operation are null.

@:value({ changeRect : null })unlock(?changeRect:Rectangle):Void

When targeting AIR, this method Unlocks an image so that any objects that reference +the BitmapData object, such as Bitmap objects, are updated when this BitmapData object changes.

To improve performance, use this method along with the lock() method before and after numerous calls to the setPixel() or diff --git a/flixel/system/debug/interaction/tools/GraphicCursorCross.html b/flixel/system/debug/interaction/tools/GraphicCursorCross.html index a5bea6b06a..592709276f 100644 --- a/flixel/system/debug/interaction/tools/GraphicCursorCross.html +++ b/flixel/system/debug/interaction/tools/GraphicCursorCross.html @@ -53,19 +53,16 @@ upper-left corner of the rectangular area where the new channel data is placed. To copy only channel data from one area to a different area in -the destination image, specify a point other than

-
				   (0,0).
-
sourceChannel

The source channel. Use a value from the -BitmapDataChannel class

-
				   (`BitmapDataChannel.RED`,
-
-

BitmapDataChannel.BLUE, +the destination image, specify a point other than +(0,0).

sourceChannel

The source channel. Use a value from the +BitmapDataChannel class +(BitmapDataChannel.RED, +BitmapDataChannel.BLUE, BitmapDataChannel.GREEN, BitmapDataChannel.ALPHA).

destChannel

The destination channel. Use a value from the -BitmapDataChannel class

-
				   (`BitmapDataChannel.RED`,
-
-

BitmapDataChannel.BLUE, +BitmapDataChannel class +(BitmapDataChannel.RED, +BitmapDataChannel.BLUE, BitmapDataChannel.GREEN, BitmapDataChannel.ALPHA).

Throws:

TypeError

The sourceBitmapData, sourceRect or destPoint are null.

See also:

@:value({ mergeAlpha : false, alphaPoint : null, alphaBitmapData : null })copyPixels(sourceBitmapData:BitmapData, sourceRect:Rectangle, destPoint:Point, ?alphaBitmapData:BitmapData, ?alphaPoint:Point, mergeAlpha:Bool = false):Void

Provides a fast routine to perform pixel manipulation between images with no stretching, rotation, or color effects. This method copies a @@ -351,10 +348,10 @@ considered opaque in the second BitmapData object. Use this parameter only when the value of secondObject is a BitmapData object and both BitmapData objects are transparent.

Returns:

A value of true if a hit occurs; otherwise, false.

Throws:

ArgumentError

The secondObject parameter is not a Point, Rectangle, -Bitmap, or BitmapData object.

TypeError

The firstPoint is null.

lock():Void

When targeting AIR, this method locks an image so that any objects -that reference the BitmapData object, such as Bitmap objects, are not -updated when this BitmapData object changes. To improve performance, -use this method along with the unlock() method before and after numerous +Bitmap, or BitmapData object.

TypeError

The firstPoint is null.

lock():Void

When targeting AIR, this method locks an image so that any objects +that reference the BitmapData object, such as Bitmap objects, are not +updated when this BitmapData object changes. To improve performance, +use this method along with the unlock() method before and after numerous calls to the setPixel() or setPixel32() method.

Note: This method only provides an optimization on the AIR(Flash) target. For all other targets, this method contains an empty function body.

merge(sourceBitmapData:BitmapData, sourceRect:Rectangle, destPoint:Point, redMultiplier:UInt, greenMultiplier:UInt, blueMultiplier:UInt, alphaMultiplier:UInt):Void

Performs per-channel blending from a source image to a destination image. For @@ -544,8 +541,8 @@ destination when the threshold test fails. If the value is false, the source image is not copied when the threshold test fails.

Returns:

The number of pixels that were changed.

Throws:

ArgumentError

The operation string is not a valid operation

TypeError

The sourceBitmapData, sourceRect destPoint or -operation are null.

@:value({ changeRect : null })unlock(?changeRect:Rectangle):Void

When targeting AIR, this method Unlocks an image so that any objects that reference -the BitmapData object, such as Bitmap objects, are updated when this BitmapData object +operation are null.

@:value({ changeRect : null })unlock(?changeRect:Rectangle):Void

When targeting AIR, this method Unlocks an image so that any objects that reference +the BitmapData object, such as Bitmap objects, are updated when this BitmapData object changes.

To improve performance, use this method along with the lock() method before and after numerous calls to the setPixel() or diff --git a/flixel/system/frontEnds/AssetFrontEnd.html b/flixel/system/frontEnds/AssetFrontEnd.html index 56a2c2edb2..5d5d8bbe52 100644 --- a/flixel/system/frontEnds/AssetFrontEnd.html +++ b/flixel/system/frontEnds/AssetFrontEnd.html @@ -28,7 +28,7 @@

Quick Setup for "Hot-Reloading"

it will automatically grab assets from your project root's assets folder rather than, the default "export/hl/bin/assets". This will only work with a single asset root folder with one asset library and will use the openfl asset system if the asset id starts with "flixel/" or -tries to references a specific library using the format: "libName:asset/path/file.ext".

Available since

5.9.0

.

Constructor

new()

Methods

dynamicexists(id:String, ?type:FlxAssetType):Bool

Whether a specific asset ID and type exists. +tries to references a specific library using the format: "libName:asset/path/file.ext".

Available since

5.9.0

.

Constructor

new()

Variables

@:value(".ogg")finaldefaultSoundExtension:String = ".ogg"

Methods

dynamicexists(id:String, ?type:FlxAssetType):Bool

Whether a specific asset ID and type exists. Can be set to a custom function to avoid the existing asset system.

Parameters:

id

The ID or asset path for the asset

type

The asset type to match, or null to match any type

@:value({ useCache : true })getAsset(id:String, type:FlxAssetType, useCache:Bool = true, ?logStyle:LogStyle):Null<Any>

Calls getAssetUnsafe if the asset exists, otherwise logs that the asset is missing, via FlxG.log

Parameters:

id

The id of the asset, usually a path

type

The type of asset to look for, determines the type

useCache

Whether to allow use of the asset cache (if one exists)

logStyle

How to log, if the asset is not found. Uses LogStyle.ERROR by default

@:value({ useCache : true })dynamicgetAssetUnsafe(id:String, type:FlxAssetType, useCache:Bool = true):Null<Any>

Used by methods like getAsset, getBitmapData, getText, their "unsafe" counterparts and the like to get assets synchronously. Can be set to a custom function to avoid the existing asset system. Unlike its "safe" counterpart, there is no log on missing assets

Parameters:

id

The id of the asset, usually a path

type

The type of asset to look for, determines the type

useCache

Whether to allow use of the asset cache (if one exists)

Returns:

The asset, if found, otherwise null is returned

@:value({ useCache : false })inlinegetBitmapData(id:String, useCache:Bool = false, ?logStyle:LogStyle):BitmapData

Gets an instance of a bitmap, logs when the asset is not found

Parameters:

id

The ID or asset path for the bitmap

useCache

Whether to allow use of the asset cache (if one exists)

Returns:

A new BitmapData object

@:value({ useCache : false })inlinegetBitmapDataUnsafe(id:String, useCache:Bool = false):BitmapData

Gets an instance of a bitmap. Unlike its "safe" counterpart, there is no log on missing assets

Parameters:

id

The ID or asset path for the bitmap

useCache

Whether to allow use of the asset cache (if one exists)

Returns:

A new BitmapData object

@:value({ useCache : true })inlinegetBytes(id:String, useCache:Bool = true, ?logStyle:LogStyle):Bytes

Gets the contents of a binary asset, logs when the asset is not found

@@ -38,7 +38,8 @@

Quick Setup for "Hot-Reloading"

Unlike its "safe" counterpart, there is no log on missing assets

Parameters:

id

The ID or asset path for the asset

useCache

Whether to allow use of the asset cache

@:value({ useCache : true })inlinegetJson(id:String, useCache:Bool = true, ?logStyle:LogStyle):Null<Null<Dynamic>>

Gets the contents of a json-based asset, logs when the asset is not found

Note: The default asset system does not cache json assets

Parameters:

id

The ID or asset path for the asset

useCache

Whether to allow use of the asset cache (if one exists)

logStyle

How to log, if the asset is not found. Uses LogStyle.ERROR by default

@:value({ useCache : true })inlinegetJsonUnsafe(id:String, useCache:Bool = true):Null<Null<Dynamic>>

Gets the contents of a json-based asset. Unlike its "safe" counterpart, there is no log on missing assets

-

Note: The default asset system does not cache json assets

Parameters:

id

The ID or asset path for the asset

useCache

Whether to allow use of the asset cache (if one exists)

@:value({ useCache : true })inlinegetSound(id:String, useCache:Bool = true, ?logStyle:LogStyle):Sound

Gets an instance of a sound, logs when the asset is not found

Parameters:

id

The ID or asset path for the sound

useCache

Whether to allow use of the asset cache (if one exists)

logStyle

How to log, if the asset is not found. Uses LogStyle.ERROR by default

Returns:

A new Sound object Note: Dos not return a FlxSound

@:value({ useCache : true })inlinegetSoundUnsafe(id:String, useCache:Bool = true):Sound

Gets an instance of a sound. Unlike its "safe" counterpart, there is no log on missing assets

Parameters:

id

The ID or asset path for the sound

useCache

Whether to allow use of the asset cache (if one exists)

Returns:

A new Sound object Note: Dos not return a FlxSound

@:value({ useCache : true })inlinegetText(id:String, useCache:Bool = true, ?logStyle:LogStyle):String

Gets the contents of a text-based asset, logs when the asset is not found

+

Note: The default asset system does not cache json assets

Parameters:

id

The ID or asset path for the asset

useCache

Whether to allow use of the asset cache (if one exists)

@:value({ useCache : true })inlinegetSound(id:String, useCache:Bool = true, ?logStyle:LogStyle):Sound

Gets an instance of a sound, logs when the asset is not found.

+

Note: If the FLX_DEFAULT_SOUND_EXT flag is enabled, you may omit the file extension

Parameters:

id

The ID or asset path for the sound

useCache

Whether to allow use of the asset cache (if one exists)

logStyle

How to log, if the asset is not found. Uses LogStyle.ERROR by default

Returns:

A new Sound object Note: Dos not return a FlxSound

@:value({ useCache : true })inlinegetSoundAddExt(id:String, useCache:Bool = true, ?logStyle:LogStyle):Sound

Gets an instance of a sound, logs when the asset is not found

Parameters:

id

The ID or asset path for the sound

useCache

Whether to allow use of the asset cache (if one exists)

logStyle

How to log, if the asset is not found. Uses LogStyle.ERROR by default

Returns:

A new Sound object Note: Dos not return a FlxSound

@:value({ useCache : true })inlinegetSoundUnsafe(id:String, useCache:Bool = true):Sound

Gets an instance of a sound. Unlike its "safe" counterpart, there is no log on missing assets

Parameters:

id

The ID or asset path for the sound

useCache

Whether to allow use of the asset cache (if one exists)

Returns:

A new Sound object Note: Dos not return a FlxSound

@:value({ useCache : true })inlinegetText(id:String, useCache:Bool = true, ?logStyle:LogStyle):String

Gets the contents of a text-based asset, logs when the asset is not found

Note: The default asset system does not cache text assets

Parameters:

id

The ID or asset path for the asset

useCache

Whether to allow use of the asset cache (if one exists)

logStyle

How to log, if the asset is not found. Uses LogStyle.ERROR by default

@:value({ useCache : true })inlinegetTextUnsafe(id:String, useCache:Bool = true):String

Gets the contents of a text-based asset. Unlike its "safe" counterpart, there is no log on missing assets

Note: The default asset system does not cache text assets

Parameters:

id

The ID or asset path for the asset

useCache

Whether to allow use of the asset cache (if one exists)

@:value({ useCache : true })inlinegetXml(id:String, useCache:Bool = true, ?logStyle:LogStyle):Null<Null<Xml>>

Parses the contents of an xml-based asset into an Xml object, logs when the asset is not found

diff --git a/flixel/system/frontEnds/BitmapFrontEnd.html b/flixel/system/frontEnds/BitmapFrontEnd.html index 4002e8c8c0..39d6e693b2 100644 --- a/flixel/system/frontEnds/BitmapFrontEnd.html +++ b/flixel/system/frontEnds/BitmapFrontEnd.html @@ -9,9 +9,9 @@ }

class BitmapFrontEnd

package flixel.system.frontEnds

@:directlyUsed@:build(hscript.macros.UsingHandler.build())@:build(hscript.macros.ClassExtendMacro.build())

Internal storage system to prevent graphics from being used repeatedly in memory.

Accessed via FlxG.bitmap.

Constructor

new()

Variables

read onlywhitePixel:FlxFrame

Helper FlxFrame object. Containing only one frame. -Useful for drawing colored rectangles of all sizes in FlxG.renderTile mode.

Methods

@:value({ Unique : false })add(Graphic:FlxGraphicAsset, Unique:Bool = false, ?Key:String):FlxGraphic

Loads a bitmap from a file, clones it if necessary and caches it.

Parameters:

Graphic

Optional FlxGraphics object to create FlxGraphic from.

Frames

Optional FlxFramesCollection object to create FlxGraphic from.

Bitmap

Optional BitmapData object to create FlxGraphic from.

BitmapClass

Optional Class for BitmapData to create FlxGraphic from.

Str

Optional String key to use for FlxGraphic instantiation.

Unique

Ensures that the bitmap data uses a new slot in the cache.

Key

Force the cache to use a specific Key to index the bitmap.

Returns:

The FlxGraphic we just created.

inlineaddGraphic(graphic:FlxGraphic):FlxGraphic

Caches specified FlxGraphic object.

Parameters:

graphic

FlxGraphic to store in the cache.

Returns:

cached FlxGraphic object.

inlinecheckCache(Key:String):Bool

Check the local bitmap cache to see if a bitmap with this key has been loaded already.

Parameters:

Key

The string key identifying the bitmap.

Returns:

Whether or not this file can be found in the cache.

clearCache():Void

Clears image cache (and destroys those images). +Useful for drawing colored rectangles of all sizes in FlxG.renderTile mode.

Methods

@:value({ unique : false })add(graphic:FlxGraphicAsset, unique:Bool = false, ?key:String):FlxGraphic

Loads a bitmap from a file, clones it if necessary and caches it.

Parameters:

graphic

Optional FlxGraphics object to create FlxGraphic from.

unique

Ensures that the bitmap data uses a new slot in the cache.

key

Force the cache to use a specific Key to index the bitmap.

Returns:

The FlxGraphic we just created.

inlineaddGraphic(graphic:FlxGraphic):FlxGraphic

Caches the specified graphic.

Parameters:

graphic

The graphic to cache.

Returns:

The cached graphic.

inlinecheckCache(key:String):Bool

Check the local bitmap cache to see if a bitmap with this key has been loaded already.

Parameters:

key

The key identifying the bitmap.

Returns:

Whether or not this file can be found in the cache.

clearCache():Void

Clears image cache (and destroys those images). Graphics object will be removed and destroyed only if it shouldn't persist in the cache and its useCount is 0.

clearUnused():Void

Removes all unused graphics from cache, -but skips graphics which should persist in cache and shouldn't be destroyed on no use.

@:value({ Unique : false })create(Width:Int, Height:Int, Color:FlxColor, Unique:Bool = false, ?Key:String):FlxGraphic

Generates a new BitmapData object (a colored rectangle) and caches it.

Parameters:

Width

How wide the rectangle should be.

Height

How high the rectangle should be.

Color

What color the rectangle should be (0xAARRGGBB)

Unique

Ensures that the bitmap data uses a new slot in the cache.

Key

Force the cache to use a specific Key to index the bitmap.

Returns:

The BitmapData we just created.

dumpCache():Void

Dumps bits of all graphics in the cache. This frees some memory, but you can't read/write pixels on those graphics anymore. -You can call undump() method for each FlxGraphic (or undumpCache()) object which will restore it again.

findKeyForBitmap(bmd:BitmapData):String

Gets key from bitmap cache for specified BitmapData

Parameters:

bmd

BitmapData to find in cache

Returns:

BitmapData's key or null if there isn't such BitmapData in cache

@:value({ unique : false })generateKey(systemKey:String, userKey:String, unique:Bool = false):String

Creates string key for further caching.

Parameters:

systemKey

The first string key to use as a base for a new key. It's usually an asset key ("assets/image.png").

userKey

The second string key to use as a base for a new key. It's usually a key provided by the user

unique

Whether generated key should be unique or not.

Returns:

Created key.

inlineget(key:String):FlxGraphic

Gets FlxGraphic object from this storage by specified key.

Parameters:

key

Key for FlxGraphic object (its name)

Returns:

FlxGraphic with the key name, or null if there is no such object

inlinegetKeyForClass(source:Class<Dynamic>):String

Helper method for getting cache key for FlxGraphic objects created from the class.

Parameters:

source

BitmapData source class.

Returns:

Full name for provided class.

getKeyWithSpacesAndBorders(baseKey:String, ?frameSize:FlxPoint, ?frameSpacing:FlxPoint, ?frameBorder:FlxPoint, ?region:FlxRect):String

Generates key from provided base key and information about tile size and offsets in spritesheet -and the region of image to use as spritesheet graphics source.

Parameters:

baseKey

Beginning of the key. Usually it is the key for original spritesheet graphics (like "assets/tile.png")

frameSize

the size of tile in spritesheet

frameSpacing

offsets between tiles in offsets

region

region of image to use as spritesheet graphics source

Returns:

Generated key for spritesheet with inserted spaces between tiles

getUniqueKey(?baseKey:String):String

Gets unique key for bitmap cache

Parameters:

baseKey

key's prefix

Returns:

unique key

onAssetsReload(_:Dynamic):Void

onContext():Void

New context handler. -Regenerates tilesheets for all dumped graphics objects in the cache.

remove(graphic:FlxGraphic):Void

Totally removes specified FlxGraphic object.

Parameters:

graphic

object you want to remove and destroy.

removeByKey(key:String):Void

Totally removes FlxGraphic object with specified key.

Parameters:

key

the key for cached FlxGraphic object.

removeIfNoUse(graphic:FlxGraphic):Void

reset():Void

Completely resets bitmap cache, which means destroying ALL of the cached FlxGraphic objects.

undumpCache():Void

Restores graphics of all dumped objects in the cache.

© 2024  

\ No newline at end of file +but skips graphics which should persist in cache and shouldn't be destroyed on no use.

@:value({ unique : false })create(width:Int, height:Int, color:FlxColor, unique:Bool = false, ?key:String):FlxGraphic

Creates a new graphic of a colored rectangle and caches it.

Parameters:

width

How wide the rectangle should be.

height

How high the rectangle should be.

color

What color the rectangle should be (0xAARRGGBB).

unique

Ensures that the bitmap data uses a new slot in the cache.

key

Force the cache to use a specific Key to index the bitmap.

Returns:

The created graphic.

dumpCache():Void

Dumps bits of all graphics in the cache. This frees some memory, but you can't read/write pixels on those graphics anymore. +You can call undump() method for each FlxGraphic (or undumpCache()) object which will restore it again.

findKeyForBitmap(bmd:BitmapData):String

Gets a key from a cached BitmapData.

Parameters:

bmd

BitmapData to find in the cache.

Returns:

The BitmapData's key or null if there isn't such BitmapData in cache.

@:value({ unique : false })generateKey(systemKey:String, userKey:String, unique:Bool = false):String

Creates string key for further caching.

Parameters:

systemKey

The first string key to use as a base for a new key. It's usually an asset key ("assets/image.png").

userKey

The second string key to use as a base for a new key. It's usually a key provided by the user

unique

Whether generated key should be unique or not.

Returns:

Created key.

inlineget(key:String):FlxGraphic

Gets an FlxGraphic object from this storage from its key.

Parameters:

key

The FlxGraphics key (or name).

Returns:

The FlxGraphic with the specified key, or null if the object doesn't exist.

inlinegetKeyForClass(source:Class<Dynamic>):String

Helper method for getting cache key for FlxGraphic objects created from the class.

Parameters:

source

BitmapData source class.

Returns:

Full name for provided class.

getKeyWithSpacesAndBorders(baseKey:String, ?frameSize:FlxPoint, ?frameSpacing:FlxPoint, ?frameBorder:FlxPoint, ?region:FlxRect):String

Generates key from provided base key and information about tile size and offsets in spritesheet +and the region of image to use as spritesheet graphics source.

Parameters:

baseKey

Beginning of the key. Usually it is the key for original spritesheet graphics (like "assets/tile.png").

frameSize

The size of tile in spritesheet.

frameSpacing

Offsets between tiles in offsets.

region

Region of image to use as spritesheet graphics source.

Returns:

Generated key for spritesheet with inserted spaces between tiles.

getUniqueKey(?baseKey:String):String

Gets unique key for bitmap cache.

Parameters:

baseKey

key's prefix.

Returns:

unique key.

onAssetsReload(_:Dynamic):Void

onContext():Void

New context handler. +Regenerates tilesheets for all dumped graphics objects in the cache.

remove(graphic:FlxGraphic):Void

Totally removes specified FlxGraphic object.

Parameters:

graphic

The object you want to remove and destroy.

removeByKey(key:String):Void

Totally removes FlxGraphic object with specified key.

Parameters:

key

Key of the cached graphic.

removeIfNoUse(graphic:FlxGraphic):Void

reset():Void

Completely resets bitmap cache, which means destroying ALL of the cached FlxGraphic objects.

undumpCache():Void

Restores graphics of all dumped objects in the cache.

\ No newline at end of file diff --git a/flixel/system/frontEnds/SoundFrontEnd.html b/flixel/system/frontEnds/SoundFrontEnd.html index 04281aae3d..bd39d03ee9 100644 --- a/flixel/system/frontEnds/SoundFrontEnd.html +++ b/flixel/system/frontEnds/SoundFrontEnd.html @@ -15,8 +15,11 @@ Default keys: + (and numpad +). Set to null to deactivate.

volumeHandler:Float ‑> Void

Deprecated: "volumeHandler is deprecated, use onVolumeChange, instead"

Set this hook to get a callback whenever the volume changes. Function should take the form myVolumeHandler(volume:Float).

Methods

inlinecache(embeddedSound:String):Sound

Method for sound caching (especially useful on mobile targets). The game may freeze for some time the first time you try to play a sound if you don't use this method.

Parameters:

embeddedSound

Name of sound assets specified in your .xml project file

Returns:

Cached Sound object

cacheAll():Void

Calls FlxG.sound.cache() on all sounds that are embedded. -WARNING: can lead to high memory usage.

changeVolume(Amount:Float):Void

Changes the volume by a certain amount, also activating the sound tray.

@:value({ forceDestroy : false })destroy(forceDestroy:Bool = false):Void

Called by FlxGame on state changes to stop and destroy sounds.

Parameters:

forceDestroy

Kill sounds even if persist is true.

@:value({ autoPlay : false, autoDestroy : false, looped : false, volume : 1.0 })load(?embeddedSound:Null<FlxSoundAsset>, volume:Float = 1.0, looped:Bool = false, ?group:FlxSoundGroup, autoDestroy:Bool = false, autoPlay:Bool = false, ?url:String, ?onComplete:() ‑> Void, ?onLoad:() ‑> Void):FlxSound

Creates a new FlxSound object.

Parameters:

embeddedSound

The embedded sound resource you want to play. To stream, use the optional URL parameter instead.

volume

How loud to play it (0 to 1).

looped

Whether to loop this sound.

group

The group to add this sound to.

autoDestroy

Whether to destroy this sound when it finishes playing. -Leave this value set to "false" if you want to re-use this FlxSound instance.

autoPlay

Whether to play the sound.

url

Load a sound from an external web resource instead. Only used if EmbeddedSound = null.

onComplete

Called when the sound finished playing.

onLoad

Called when the sound finished loading. Called immediately for succesfully loaded embedded sounds.

Returns:

A FlxSound object.

pause():Void

Pause all sounds currently playing.

@:value({ autoDestroy : true, looped : false, volume : 1.0 })play(embeddedSound:FlxSoundAsset, volume:Float = 1.0, looped:Bool = false, ?group:FlxSoundGroup, autoDestroy:Bool = true, ?onComplete:() ‑> Void):FlxSound

Plays a sound from an embedded sound. Tries to recycle a cached sound first.

Parameters:

embeddedSound

The embedded sound resource you want to play.

volume

How loud to play it (0 to 1).

looped

Whether to loop this sound.

group

The group to add this sound to.

autoDestroy

Whether to destroy this sound when it finishes playing. -Leave this value set to "false" if you want to re-use this FlxSound instance.

onComplete

Called when the sound finished playing

Returns:

A FlxSound object.

@:value({ looped : true, volume : 1.0 })playMusic(embeddedMusic:FlxSoundAsset, volume:Float = 1.0, looped:Bool = true, ?group:FlxSoundGroup):Void

Set up and play a looping background soundtrack.

Parameters:

embeddedMusic

The sound file you want to loop in the background.

volume

How loud the sound should be, from 0 to 1.

looped

Whether to loop this music.

group

The group to add this sound to.

resume():Void

Resume playing existing sounds.

@:value({ up : false })showSoundTray(up:Bool = false):Void

Shows the sound tray if it is enabled.

Parameters:

up

Whether or not the volume is increasing.

@:value({ autoDestroy : true, looped : false, volume : 1.0 })stream(url:String, volume:Float = 1.0, looped:Bool = false, ?group:FlxSoundGroup, autoDestroy:Bool = true, ?onComplete:() ‑> Void, ?onLoad:() ‑> Void):FlxSound

Plays a sound from a URL. Tries to recycle a cached sound first. +WARNING: can lead to high memory usage.

changeVolume(Amount:Float):Void

Changes the volume by a certain amount, also activating the sound tray.

@:value({ forceDestroy : false })destroy(forceDestroy:Bool = false):Void

Called by FlxGame on state changes to stop and destroy sounds.

Parameters:

forceDestroy

Kill sounds even if persist is true.

@:value({ autoPlay : false, autoDestroy : false, looped : false, volume : 1.0 })load(?embeddedSound:Null<FlxSoundAsset>, volume:Float = 1.0, looped:Bool = false, ?group:FlxSoundGroup, autoDestroy:Bool = false, autoPlay:Bool = false, ?url:String, ?onComplete:() ‑> Void, ?onLoad:() ‑> Void):FlxSound

Creates a new FlxSound object.

+

Note: If the FLX_DEFAULT_SOUND_EXT flag is enabled, you may omit the file extension

Parameters:

embeddedSound

The embedded sound resource you want to play. To stream, use the optional URL parameter instead.

volume

How loud to play it (0 to 1).

looped

Whether to loop this sound.

group

The group to add this sound to.

autoDestroy

Whether to destroy this sound when it finishes playing. +Leave this value set to "false" if you want to re-use this FlxSound instance.

autoPlay

Whether to play the sound.

url

Load a sound from an external web resource instead. Only used if EmbeddedSound = null.

onComplete

Called when the sound finished playing.

onLoad

Called when the sound finished loading. Called immediately for succesfully loaded embedded sounds.

Returns:

A FlxSound object.

pause():Void

Pause all sounds currently playing.

@:value({ autoDestroy : true, looped : false, volume : 1.0 })play(embeddedSound:FlxSoundAsset, volume:Float = 1.0, looped:Bool = false, ?group:FlxSoundGroup, autoDestroy:Bool = true, ?onComplete:() ‑> Void):FlxSound

Plays a sound from an embedded sound. Tries to recycle a cached sound first.

+

Note: If the FLX_DEFAULT_SOUND_EXT flag is enabled, you may omit the file extension

Parameters:

embeddedSound

The embedded sound resource you want to play.

volume

How loud to play it (0 to 1).

looped

Whether to loop this sound.

group

The group to add this sound to.

autoDestroy

Whether to destroy this sound when it finishes playing. +Leave this value set to "false" if you want to re-use this FlxSound instance.

onComplete

Called when the sound finished playing

Returns:

A FlxSound object.

@:value({ looped : true, volume : 1.0 })playMusic(embeddedMusic:FlxSoundAsset, volume:Float = 1.0, looped:Bool = true, ?group:FlxSoundGroup):Void

Set up and play a looping background soundtrack.

+

Note: If the FLX_DEFAULT_SOUND_EXT flag is enabled, you may omit the file extension

Parameters:

embeddedMusic

The sound file you want to loop in the background.

volume

How loud the sound should be, from 0 to 1.

looped

Whether to loop this music.

group

The group to add this sound to.

resume():Void

Resume playing existing sounds.

@:value({ up : false })showSoundTray(up:Bool = false):Void

Shows the sound tray if it is enabled.

Parameters:

up

Whether or not the volume is increasing.

@:value({ autoDestroy : true, looped : false, volume : 1.0 })stream(url:String, volume:Float = 1.0, looped:Bool = false, ?group:FlxSoundGroup, autoDestroy:Bool = true, ?onComplete:() ‑> Void, ?onLoad:() ‑> Void):FlxSound

Plays a sound from a URL. Tries to recycle a cached sound first. NOTE: Just calls FlxG.sound.load() with AutoPlay == true.

Parameters:

url

Load a sound from an external web resource instead.

volume

How loud to play it (0 to 1).

looped

Whether to loop this sound.

group

The group to add this sound to.

autoDestroy

Whether to destroy this sound when it finishes playing. Leave this value set to "false" if you want to re-use this FlxSound instance.

onComplete

Called when the sound finished playing

onLoad

Called when the sound finished loading.

Returns:

A FlxSound object.

@:haxe.warning("-WDeprecated")toggleMuted():Void

Toggles muted, also activating the sound tray.

\ No newline at end of file diff --git a/flixel/tile/GraphicAuto.html b/flixel/tile/GraphicAuto.html index 09a5ea797b..c910c14347 100644 --- a/flixel/tile/GraphicAuto.html +++ b/flixel/tile/GraphicAuto.html @@ -53,19 +53,16 @@ upper-left corner of the rectangular area where the new channel data is placed. To copy only channel data from one area to a different area in -the destination image, specify a point other than

-
				   (0,0).
-
sourceChannel

The source channel. Use a value from the -BitmapDataChannel class

-
				   (`BitmapDataChannel.RED`,
-
-

BitmapDataChannel.BLUE, +the destination image, specify a point other than +(0,0).

sourceChannel

The source channel. Use a value from the +BitmapDataChannel class +(BitmapDataChannel.RED, +BitmapDataChannel.BLUE, BitmapDataChannel.GREEN, BitmapDataChannel.ALPHA).

destChannel

The destination channel. Use a value from the -BitmapDataChannel class

-
				   (`BitmapDataChannel.RED`,
-
-

BitmapDataChannel.BLUE, +BitmapDataChannel class +(BitmapDataChannel.RED, +BitmapDataChannel.BLUE, BitmapDataChannel.GREEN, BitmapDataChannel.ALPHA).

Throws:

TypeError

The sourceBitmapData, sourceRect or destPoint are null.

See also:

@:value({ mergeAlpha : false, alphaPoint : null, alphaBitmapData : null })copyPixels(sourceBitmapData:BitmapData, sourceRect:Rectangle, destPoint:Point, ?alphaBitmapData:BitmapData, ?alphaPoint:Point, mergeAlpha:Bool = false):Void

Provides a fast routine to perform pixel manipulation between images with no stretching, rotation, or color effects. This method copies a @@ -351,10 +348,10 @@ considered opaque in the second BitmapData object. Use this parameter only when the value of secondObject is a BitmapData object and both BitmapData objects are transparent.

Returns:

A value of true if a hit occurs; otherwise, false.

Throws:

ArgumentError

The secondObject parameter is not a Point, Rectangle, -Bitmap, or BitmapData object.

TypeError

The firstPoint is null.

lock():Void

When targeting AIR, this method locks an image so that any objects -that reference the BitmapData object, such as Bitmap objects, are not -updated when this BitmapData object changes. To improve performance, -use this method along with the unlock() method before and after numerous +Bitmap, or BitmapData object.

TypeError

The firstPoint is null.

lock():Void

When targeting AIR, this method locks an image so that any objects +that reference the BitmapData object, such as Bitmap objects, are not +updated when this BitmapData object changes. To improve performance, +use this method along with the unlock() method before and after numerous calls to the setPixel() or setPixel32() method.

Note: This method only provides an optimization on the AIR(Flash) target. For all other targets, this method contains an empty function body.

merge(sourceBitmapData:BitmapData, sourceRect:Rectangle, destPoint:Point, redMultiplier:UInt, greenMultiplier:UInt, blueMultiplier:UInt, alphaMultiplier:UInt):Void

Performs per-channel blending from a source image to a destination image. For @@ -544,8 +541,8 @@ destination when the threshold test fails. If the value is false, the source image is not copied when the threshold test fails.

Returns:

The number of pixels that were changed.

Throws:

ArgumentError

The operation string is not a valid operation

TypeError

The sourceBitmapData, sourceRect destPoint or -operation are null.

@:value({ changeRect : null })unlock(?changeRect:Rectangle):Void

When targeting AIR, this method Unlocks an image so that any objects that reference -the BitmapData object, such as Bitmap objects, are updated when this BitmapData object +operation are null.

@:value({ changeRect : null })unlock(?changeRect:Rectangle):Void

When targeting AIR, this method Unlocks an image so that any objects that reference +the BitmapData object, such as Bitmap objects, are updated when this BitmapData object changes.

To improve performance, use this method along with the lock() method before and after numerous calls to the setPixel() or diff --git a/flixel/tile/GraphicAutoAlt.html b/flixel/tile/GraphicAutoAlt.html index 723a2d4688..257035fbda 100644 --- a/flixel/tile/GraphicAutoAlt.html +++ b/flixel/tile/GraphicAutoAlt.html @@ -53,19 +53,16 @@ upper-left corner of the rectangular area where the new channel data is placed. To copy only channel data from one area to a different area in -the destination image, specify a point other than

-
				   (0,0).
-
sourceChannel

The source channel. Use a value from the -BitmapDataChannel class

-
				   (`BitmapDataChannel.RED`,
-
-

BitmapDataChannel.BLUE, +the destination image, specify a point other than +(0,0).

sourceChannel

The source channel. Use a value from the +BitmapDataChannel class +(BitmapDataChannel.RED, +BitmapDataChannel.BLUE, BitmapDataChannel.GREEN, BitmapDataChannel.ALPHA).

destChannel

The destination channel. Use a value from the -BitmapDataChannel class

-
				   (`BitmapDataChannel.RED`,
-
-

BitmapDataChannel.BLUE, +BitmapDataChannel class +(BitmapDataChannel.RED, +BitmapDataChannel.BLUE, BitmapDataChannel.GREEN, BitmapDataChannel.ALPHA).

Throws:

TypeError

The sourceBitmapData, sourceRect or destPoint are null.

See also:

@:value({ mergeAlpha : false, alphaPoint : null, alphaBitmapData : null })copyPixels(sourceBitmapData:BitmapData, sourceRect:Rectangle, destPoint:Point, ?alphaBitmapData:BitmapData, ?alphaPoint:Point, mergeAlpha:Bool = false):Void

Provides a fast routine to perform pixel manipulation between images with no stretching, rotation, or color effects. This method copies a @@ -351,10 +348,10 @@ considered opaque in the second BitmapData object. Use this parameter only when the value of secondObject is a BitmapData object and both BitmapData objects are transparent.

Returns:

A value of true if a hit occurs; otherwise, false.

Throws:

ArgumentError

The secondObject parameter is not a Point, Rectangle, -Bitmap, or BitmapData object.

TypeError

The firstPoint is null.

lock():Void

When targeting AIR, this method locks an image so that any objects -that reference the BitmapData object, such as Bitmap objects, are not -updated when this BitmapData object changes. To improve performance, -use this method along with the unlock() method before and after numerous +Bitmap, or BitmapData object.

TypeError

The firstPoint is null.

lock():Void

When targeting AIR, this method locks an image so that any objects +that reference the BitmapData object, such as Bitmap objects, are not +updated when this BitmapData object changes. To improve performance, +use this method along with the unlock() method before and after numerous calls to the setPixel() or setPixel32() method.

Note: This method only provides an optimization on the AIR(Flash) target. For all other targets, this method contains an empty function body.

merge(sourceBitmapData:BitmapData, sourceRect:Rectangle, destPoint:Point, redMultiplier:UInt, greenMultiplier:UInt, blueMultiplier:UInt, alphaMultiplier:UInt):Void

Performs per-channel blending from a source image to a destination image. For @@ -544,8 +541,8 @@ destination when the threshold test fails. If the value is false, the source image is not copied when the threshold test fails.

Returns:

The number of pixels that were changed.

Throws:

ArgumentError

The operation string is not a valid operation

TypeError

The sourceBitmapData, sourceRect destPoint or -operation are null.

@:value({ changeRect : null })unlock(?changeRect:Rectangle):Void

When targeting AIR, this method Unlocks an image so that any objects that reference -the BitmapData object, such as Bitmap objects, are updated when this BitmapData object +operation are null.

@:value({ changeRect : null })unlock(?changeRect:Rectangle):Void

When targeting AIR, this method Unlocks an image so that any objects that reference +the BitmapData object, such as Bitmap objects, are updated when this BitmapData object changes.

To improve performance, use this method along with the lock() method before and after numerous calls to the setPixel() or diff --git a/flixel/tile/GraphicAutoFull.html b/flixel/tile/GraphicAutoFull.html index 90ec822d00..dfacbf2338 100644 --- a/flixel/tile/GraphicAutoFull.html +++ b/flixel/tile/GraphicAutoFull.html @@ -53,19 +53,16 @@ upper-left corner of the rectangular area where the new channel data is placed. To copy only channel data from one area to a different area in -the destination image, specify a point other than

-
				   (0,0).
-
sourceChannel

The source channel. Use a value from the -BitmapDataChannel class

-
				   (`BitmapDataChannel.RED`,
-
-

BitmapDataChannel.BLUE, +the destination image, specify a point other than +(0,0).

sourceChannel

The source channel. Use a value from the +BitmapDataChannel class +(BitmapDataChannel.RED, +BitmapDataChannel.BLUE, BitmapDataChannel.GREEN, BitmapDataChannel.ALPHA).

destChannel

The destination channel. Use a value from the -BitmapDataChannel class

-
				   (`BitmapDataChannel.RED`,
-
-

BitmapDataChannel.BLUE, +BitmapDataChannel class +(BitmapDataChannel.RED, +BitmapDataChannel.BLUE, BitmapDataChannel.GREEN, BitmapDataChannel.ALPHA).

Throws:

TypeError

The sourceBitmapData, sourceRect or destPoint are null.

See also:

@:value({ mergeAlpha : false, alphaPoint : null, alphaBitmapData : null })copyPixels(sourceBitmapData:BitmapData, sourceRect:Rectangle, destPoint:Point, ?alphaBitmapData:BitmapData, ?alphaPoint:Point, mergeAlpha:Bool = false):Void

Provides a fast routine to perform pixel manipulation between images with no stretching, rotation, or color effects. This method copies a @@ -351,10 +348,10 @@ considered opaque in the second BitmapData object. Use this parameter only when the value of secondObject is a BitmapData object and both BitmapData objects are transparent.

Returns:

A value of true if a hit occurs; otherwise, false.

Throws:

ArgumentError

The secondObject parameter is not a Point, Rectangle, -Bitmap, or BitmapData object.

TypeError

The firstPoint is null.

lock():Void

When targeting AIR, this method locks an image so that any objects -that reference the BitmapData object, such as Bitmap objects, are not -updated when this BitmapData object changes. To improve performance, -use this method along with the unlock() method before and after numerous +Bitmap, or BitmapData object.

TypeError

The firstPoint is null.

lock():Void

When targeting AIR, this method locks an image so that any objects +that reference the BitmapData object, such as Bitmap objects, are not +updated when this BitmapData object changes. To improve performance, +use this method along with the unlock() method before and after numerous calls to the setPixel() or setPixel32() method.

Note: This method only provides an optimization on the AIR(Flash) target. For all other targets, this method contains an empty function body.

merge(sourceBitmapData:BitmapData, sourceRect:Rectangle, destPoint:Point, redMultiplier:UInt, greenMultiplier:UInt, blueMultiplier:UInt, alphaMultiplier:UInt):Void

Performs per-channel blending from a source image to a destination image. For @@ -544,8 +541,8 @@ destination when the threshold test fails. If the value is false, the source image is not copied when the threshold test fails.

Returns:

The number of pixels that were changed.

Throws:

ArgumentError

The operation string is not a valid operation

TypeError

The sourceBitmapData, sourceRect destPoint or -operation are null.

@:value({ changeRect : null })unlock(?changeRect:Rectangle):Void

When targeting AIR, this method Unlocks an image so that any objects that reference -the BitmapData object, such as Bitmap objects, are updated when this BitmapData object +operation are null.

@:value({ changeRect : null })unlock(?changeRect:Rectangle):Void

When targeting AIR, this method Unlocks an image so that any objects that reference +the BitmapData object, such as Bitmap objects, are updated when this BitmapData object changes.

To improve performance, use this method along with the lock() method before and after numerous calls to the setPixel() or diff --git a/game/StageGroup.html b/game/StageGroup.html index 9682db3aca..a0d268a698 100644 --- a/game/StageGroup.html +++ b/game/StageGroup.html @@ -7,7 +7,7 @@ float: none; text-shadow: 0 0 0 transparent; } -

class StageGroup

package game

extends FlxTypedGroup › FlxBasic

@:directlyUsed

Constructor

new(?stageName:String)

Variables

@:value(1.05)camZoom:Float = 1.05

colorSwap:ColorSwapHSV

@:value(new FlxGroup())foregroundSprites:FlxGroup = new FlxGroup()

@:value(new FlxPoint(600, 750))gf_Point:FlxPoint = new FlxPoint(600, 750)

@:value(0.95)gf_Scroll:Float = 0.95

@:value(new FlxGroup())infrontOfGFSprites:FlxGroup = new FlxGroup()

@:value(new FlxTypedGroup<FlxSprite>())onBeatHit_Group:FlxTypedGroup<FlxSprite> = new FlxTypedGroup<FlxSprite>()

@:value(new FlxPoint(0, 0))p1_Cam_Offset:FlxPoint = new FlxPoint(0, 0)

@:value(1.0)p1_Scroll:Float = 1.0

@:value(new FlxPoint(0, 0))p2_Cam_Offset:FlxPoint = new FlxPoint(0, 0)

@:value(1.0)p2_Scroll:Float = 1.0

@:value(new FlxPoint(1000, 800))player_1_Point:FlxPoint = new FlxPoint(1000, 800)

@:value(new FlxPoint(300, 800))player_2_Point:FlxPoint = new FlxPoint(300, 800)

@:value("stage")stage:String = "stage"

@:value(null)stageScript:ModchartUtilities = null

stage_Data:StageData

@:value([])stage_Objects:Array<Array<Dynamic>> = []

Methods

beatHit():Void

createLuaStuff():Void

@:value({ char : null })getCharacterPos(character:Int, ?char:Character):Array<Float>

getNamedProp(prop:String):FlxSprite

Returns a named sprite from a string, if it exists. +

class StageGroup

package game

extends FlxTypedGroup › FlxBasic

@:directlyUsed

Constructor

new(?stageName:String)

Variables

@:value(1.05)camZoom:Float = 1.05

colorSwap:ColorSwapHSV

@:value(new FlxGroup())foregroundSprites:FlxGroup = new FlxGroup()

@:value(new FlxPoint(600, 750))gf_Point:FlxPoint = new FlxPoint(600, 750)

@:value(0.95)gf_Scroll:Float = 0.95

@:value(new FlxGroup())infrontOfGFSprites:FlxGroup = new FlxGroup()

@:value(new FlxTypedGroup<FlxSprite>())onBeatHit_Group:FlxTypedGroup<FlxSprite> = new FlxTypedGroup<FlxSprite>()

@:value(new FlxPoint(0, 0))p1_Cam_Offset:FlxPoint = new FlxPoint(0, 0)

@:value(1.0)p1_Scroll:Float = 1.0

@:value(new FlxPoint(0, 0))p2_Cam_Offset:FlxPoint = new FlxPoint(0, 0)

@:value(1.0)p2_Scroll:Float = 1.0

@:value(new FlxPoint(1000, 800))player_1_Point:FlxPoint = new FlxPoint(1000, 800)

@:value(new FlxPoint(300, 800))player_2_Point:FlxPoint = new FlxPoint(300, 800)

@:value("stage")stage:String = "stage"

stageData:StageData

@:value([])stageObjects:Array<Array<Dynamic>> = []

@:value(null)stageScript:Script = null

Methods

beatHit():Void

@:value({ char : null })getCharacterPos(character:Int, ?char:Character):Array<Float>

getNamedProp(prop:String):FlxSprite

Returns a named sprite from a string, if it exists. Otherwise, returns null.

Parameters:

prop

Returns:

FlxSprite

setCharOffsets(?p1:Character, ?gf:Character, ?p2:Character):Void

updateStage(?newStage:String):Void

Inherited Variables

Defined by FlxTypedGroup

@:value(0)read onlylength:Int = 0

The number of entries in the members array. For performance and safety you should check this variable instead of members.length unless you really know what you're doing!

maxSize:Int

The maximum capacity of this group. Default is 0, meaning no max capacity, and the group can just grow.

read onlymemberAdded:FlxTypedSignal<T ‑> Void>

A FlxSignal that dispatches when a child is added to this group.

Available since

4.4.0

.

read onlymemberRemoved:FlxTypedSignal<T ‑> Void>

A FlxSignal that dispatches when a child is removed from this group.

Available since

4.4.0

.

read onlymembers:Array<T>

Array of all the members in this group.

Defined by FlxBasic

@:value(idEnumerator++)ID:Int = idEnumerator++

A unique ID starting from 0 and increasing by 1 for each subsequent FlxBasic that is created.

@:value(true)active:Bool = true

Controls whether update() is automatically called by FlxState/FlxGroup.

@:value(true)alive:Bool = true

Useful state for many game objects - "dead" (!alive) vs alive. kill() and revive() both flip this switch (along with exists, but you can override that).

camera:FlxCamera

Gets or sets the first camera of this object.

cameras:Array<FlxCamera>

This determines on which FlxCameras this object will be drawn. If it is null / has not been diff --git a/haxe/exceptions/NotImplementedException.html b/haxe/exceptions/NotImplementedException.html index 22a5db1f92..536db00720 100644 --- a/haxe/exceptions/NotImplementedException.html +++ b/haxe/exceptions/NotImplementedException.html @@ -7,5 +7,5 @@ float: none; text-shadow: 0 0 0 transparent; } -

class NotImplementedException

package haxe.exceptions

extends PosException › Exception

@:directlyUsed

An exception that is thrown when requested function or operation does not have an implementation.

Constructor

@:value({ message : "Not implemented" })new(message:String = "Not implemented", ?previous:Exception, ?pos:PosInfos)

Inherited Variables

Defined by PosException

finalposInfos:PosInfos

Position where this exception was created.

Defined by Exception

read onlymessage:String

Exception message.

read onlynative:Any

Native exception, which caused this exception.

read onlyprevious:Null<Exception>

Contains an exception, which was passed to previous constructor argument.

read onlystack:CallStack

The call stack at the moment of the exception creation.

Inherited Methods

Defined by PosException

toString():String

Returns exception message.

Defined by Exception

details():String

Detailed exception description.

+

class NotImplementedException

package haxe.exceptions

extends PosException › Exception

@:directlyUsed

An exception that is thrown when requested function or operation does not have an implementation.

Constructor

@:value({ message : "Not implemented" })new(message:String = "Not implemented", ?previous:Exception, ?pos:Null<PosInfos>)

Inherited Variables

Defined by PosException

finalposInfos:PosInfos

Position where this exception was created.

Defined by Exception

read onlymessage:String

Exception message.

read onlynative:Any

Native exception, which caused this exception.

read onlyprevious:Null<Exception>

Contains an exception, which was passed to previous constructor argument.

read onlystack:CallStack

The call stack at the moment of the exception creation.

Inherited Methods

Defined by PosException

toString():String

Returns exception message.

Defined by Exception

details():String

Detailed exception description.

Includes message, stack and the chain of previous exceptions (if set).

© 2024  

\ No newline at end of file diff --git a/haxe/exceptions/PosException.html b/haxe/exceptions/PosException.html index bed5aef91c..255b657b73 100644 --- a/haxe/exceptions/PosException.html +++ b/haxe/exceptions/PosException.html @@ -7,5 +7,5 @@ float: none; text-shadow: 0 0 0 transparent; } -

class PosException

package haxe.exceptions

extends Exception

extended by NotImplementedException

An exception that carry position information of a place where it was created.

Constructor

new(message:String, ?previous:Exception, ?pos:PosInfos)

Variables

finalposInfos:PosInfos

Position where this exception was created.

Methods

toString():String

Returns exception message.

Inherited Variables

Defined by Exception

read onlymessage:String

Exception message.

read onlynative:Any

Native exception, which caused this exception.

read onlyprevious:Null<Exception>

Contains an exception, which was passed to previous constructor argument.

read onlystack:CallStack

The call stack at the moment of the exception creation.

Inherited Methods

Defined by Exception

details():String

Detailed exception description.

+

class PosException

package haxe.exceptions

extends Exception

extended by NotImplementedException

An exception that carry position information of a place where it was created.

Constructor

new(message:String, ?previous:Exception, ?pos:Null<PosInfos>)

Variables

finalposInfos:PosInfos

Position where this exception was created.

Methods

toString():String

Returns exception message.

Inherited Variables

Defined by Exception

read onlymessage:String

Exception message.

read onlynative:Any

Native exception, which caused this exception.

read onlyprevious:Null<Exception>

Contains an exception, which was passed to previous constructor argument.

read onlystack:CallStack

The call stack at the moment of the exception creation.

Inherited Methods

Defined by Exception

details():String

Detailed exception description.

Includes message, stack and the chain of previous exceptions (if set).

© 2024  

\ No newline at end of file diff --git a/hscript/Parser.html b/hscript/Parser.html index 847027a74c..5833391930 100644 --- a/hscript/Parser.html +++ b/hscript/Parser.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class Parser

package hscript

@:directlyUsed@:analyzer(optimize,local_dce,fusion,user_var_fusion)

Constructor

new()

Variables

allowJSON:Bool

activate JSON compatiblity

allowMetadata:Bool

allow haxe metadata declarations

allowTypes:Bool

allow types declarations

identChars:String

line:Int

opChars:String

opPriority:Map<String, Int>

opRightAssoc:Map<String, Bool>

@:value(new Map())preprocesorValues:Map<String, Dynamic> = new Map()

allows to check for #if / #else in code

resumeErrors:Bool

resume from parsing errors (when parsing incomplete code, during completion for example)

Methods

inlineerror(err:ErrorDef, pmin:Int, pmax:Int):Void

invalidChar(c:Int):Void

@:value({ origin : "hscript" })parseModule(content:String, origin:String = "hscript"):Array<ModuleDecl>

@:value({ origin : "hscript" })parseString(s:String, origin:String = "hscript"):Expr

© 2024  

\ No newline at end of file +

class Parser

package hscript

@:directlyUsed@:analyzer(optimize,local_dce,fusion,user_var_fusion)

Constructor

new()

Variables

allowJSON:Bool

activate JSON compatiblity

allowMetadata:Bool

allow haxe metadata declarations

allowTypes:Bool

allow types declarations

identChars:String

line:Int

opChars:String

opPriority:Map<String, Int>

opRightAssoc:Map<String, Bool>

preprocesorValues:Map<String, Dynamic>

@:value(new Map())preprocessorValues:Map<String, Dynamic> = new Map()

allows to check for #if / #else in code

resumeErrors:Bool

resume from parsing errors (when parsing incomplete code, during completion for example)

Methods

inlineerror(err:ErrorDef, pmin:Int, pmax:Int):Void

invalidChar(c:Int):Void

@:value({ origin : "hscript" })parseModule(content:String, origin:String = "hscript"):Array<ModuleDecl>

@:value({ origin : "hscript" })parseString(s:String, origin:String = "hscript"):Expr

© 2024  

\ No newline at end of file diff --git a/hxvlc/externs/LibVLC.html b/hxvlc/externs/LibVLC.html index 78721221c4..789644ee96 100644 --- a/hxvlc/externs/LibVLC.html +++ b/hxvlc/externs/LibVLC.html @@ -9,7 +9,7 @@ float: none; text-shadow: 0 0 0 transparent; } -

class LibVLC

package hxvlc.externs

@:directlyUsed@:buildXml("<include name=\"${haxelib:hxvlc}/project/Build.xml\" />")@:include("vlc/vlc.h")@:unreflective

This class provides static methods to interact with the LibVLC library. +

class LibVLC

package hxvlc.externs

@:directlyUsed@:nullSafety(Loose)@:buildXml("<include name=\"${haxelib:hxvlc}/project/Build.xml\" />")@:include("vlc/vlc.h")@:unreflective

This class provides static methods to interact with the LibVLC library. It allows for the creation and management of VLC instances, media players, and media objects, as well as the handling of audio, video, and events.

Static methods

@:native("libvlc_new")staticalloc(argc:Int, argv:ConstCharStarConstStar):RawPointer<LibVLC_Instance_T>

Allocates and initializes a LibVLC instance.

Parameters:

argc

Number of arguments.

argv

Argument values.

Returns:

Pointer to the new LibVLC instance.

@:native("libvlc_audio_get_channel")staticaudio_get_channel(p_mi:RawPointer<LibVLC_Media_Player_T>):Int

Gets the current audio channel.

Parameters:

p_mi

Pointer to the media player.

Returns:

The current audio channel.

@:native("libvlc_audio_get_delay")staticaudio_get_delay(p_mi:RawPointer<LibVLC_Media_Player_T>):Int64

Gets the audio delay.

Parameters:

p_mi

Pointer to the media player.

Returns:

The audio delay in microseconds.

@:native("libvlc_audio_get_mute")staticaudio_get_mute(p_mi:RawPointer<LibVLC_Media_Player_T>):Int

Gets the mute status.

Parameters:

p_mi

Pointer to the media player.

Returns:

1 if muted, 0 otherwise.

@:native("libvlc_audio_get_track")staticaudio_get_track(p_mi:RawPointer<LibVLC_Media_Player_T>):Int

Gets the current audio track.

Parameters:

p_mi

Pointer to the media player.

Returns:

The current audio track.

@:native("libvlc_audio_get_track_count")staticaudio_get_track_count(p_mi:RawPointer<LibVLC_Media_Player_T>):Int

Gets the number of audio tracks.

Parameters:

p_mi

Pointer to the media player.

Returns:

The number of audio tracks.

@:native("libvlc_audio_get_volume")staticaudio_get_volume(p_mi:RawPointer<LibVLC_Media_Player_T>):Int

Gets the audio volume.

Parameters:

p_mi

Pointer to the media player.

Returns:

The audio volume (0-100).

@:native("libvlc_audio_output_list_get")staticaudio_output_list_get(p_instance:RawPointer<LibVLC_Instance_T>):RawPointer<LibVLC_Audio_Output_T>

Gets the list of audio outputs.

Parameters:

p_instance

Pointer to the LibVLC instance.

Returns:

Pointer to the list of audio outputs.

@:native("libvlc_audio_output_list_release")staticaudio_output_list_release(p_list:RawPointer<LibVLC_Audio_Output_T>):Void

Releases the list of audio outputs.

Parameters:

p_list

Pointer to the list of audio outputs.

@:native("libvlc_audio_output_set")staticaudio_output_set(p_mi:RawPointer<LibVLC_Media_Player_T>, psz_name:ConstCharStar):Int

Sets the audio output.

Parameters:

p_mi

Pointer to the media player.

psz_name

Name of the audio output.

Returns:

0 on success, -1 on failure.

@:native("libvlc_audio_set_callbacks")staticaudio_set_callbacks(mp:RawPointer<LibVLC_Media_Player_T>, play:LibVLC_Audio_Play_CB, pause:LibVLC_Audio_Pause_CB, resume:LibVLC_Audio_Resume_CB, flush:LibVLC_Audio_Flush_CB, drain:LibVLC_Audio_Drain_CB, opaque:RawPointer<Void>):Void

Sets the audio callbacks.

Parameters:

mp

Pointer to the media player.

play

Audio play callback.

pause

Audio pause callback.

resume

Audio resume callback.

flush

Audio flush callback.

drain

Audio drain callback.

opaque

Pointer to the opaque data.

@:native("libvlc_audio_set_channel")staticaudio_set_channel(p_mi:RawPointer<LibVLC_Media_Player_T>, channel:Int):Int

Sets the current audio channel.

Parameters:

p_mi

Pointer to the media player.

channel

The new audio channel.

Returns:

0 on success, -1 on failure.

@:native("libvlc_audio_set_delay")staticaudio_set_delay(p_mi:RawPointer<LibVLC_Media_Player_T>, i_delay:Int64):Int

Sets the audio delay.

Parameters:

p_mi

Pointer to the media player.

i_delay

The new audio delay in microseconds.

Returns:

0 on success, -1 on failure.

@:native("libvlc_audio_set_format")staticaudio_set_format(mp:RawPointer<LibVLC_Media_Player_T>, format:ConstCharStar, rate:UInt32, channels:UInt32):Void

Sets the audio format.

Parameters:

mp

Pointer to the media player.

format

Audio format string.

rate

Sample rate.

channels

Number of audio channels.

@:native("libvlc_audio_set_format_callbacks")staticaudio_set_format_callbacks(mp:RawPointer<LibVLC_Media_Player_T>, setup:LibVLC_Audio_Setup_CB, cleanup:LibVLC_Audio_Cleanup_CB):Void

Sets the audio format callbacks.

Parameters:

mp

Pointer to the media player.

setup

Audio format setup callback. This callback is invoked to configure the audio format.

cleanup

Audio format cleanup callback. diff --git a/hxvlc/externs/Types.html b/hxvlc/externs/Types.html index d2da6f61b9..38596509c8 100644 --- a/hxvlc/externs/Types.html +++ b/hxvlc/externs/Types.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class Types

package hxvlc.externs

Dummy class for importing LibVLC native structures.

© 2024  

\ No newline at end of file +

class Types

package hxvlc.externs

@:nullSafety(Loose)

Dummy class for importing LibVLC native structures.

© 2024  

\ No newline at end of file diff --git a/hxvlc/flixel/FlxVideo.html b/hxvlc/flixel/FlxVideo.html index 6682e71ec7..d14af4bee4 100644 --- a/hxvlc/flixel/FlxVideo.html +++ b/hxvlc/flixel/FlxVideo.html @@ -7,7 +7,7 @@ float: none; text-shadow: 0 0 0 transparent; } -

class FlxVideo

package hxvlc.flixel

extends Video › Bitmap › DisplayObject › EventDispatcher

@:directlyUsed@:nullSafety

This class extends Video to display video files in HaxeFlixel.

+

class FlxVideo

package hxvlc.flixel

extends Video › Bitmap › DisplayObject › EventDispatcher

@:directlyUsed@:nullSafety(Loose)

This class extends Video to display video files in HaxeFlixel.

var video:FlxVideo = new FlxVideo();
 video.onEndReached.add(function():Void
 {
@@ -20,8 +20,8 @@
 if (video.load('assets/videos/video.mp4'))
 	FlxTimer.wait(0.001, () -> video.play());

Constructor

@:value({ smoothing : true })new(smoothing:Bool = true)

Initializes a FlxVideo object.

Parameters:

smoothing

Whether or not the video is smoothed when scaled.

Variables

@:value(FlxG.autoPause)autoPause:Bool = FlxG.autoPause

Whether the video should automatically pause when focus is lost.

WARNING: Must be set before loading a video.

@:value(FlxAxes.XY)autoResizeMode:FlxAxes = FlxAxes.XY

Determines the automatic resizing behavior for the video.

-

WARNING: Must be set before loading a video if you want to set it to NONE.

@:value(true)autoVolumeHandle:Bool = true

Whether Flixel should automatically adjust the volume according to the Flixel sound system's current volume.

Methods

dynamicgetCalculatedVolume():Float

Calculates and returns the current volume based on Flixel's sound settings by default.

-

The volume is automatically clamped between 0 and 1 by the calling code. If the sound is muted, the volume is 0.

Returns:

The calculated volume.

load(location:Location, ?options:Array<String>):Bool

Loads a video.

Parameters:

location

The local filesystem path, the media location URL, the ID of an open file descriptor, or the bitstream input.

options

Additional options to add to the LibVLC Media.

Returns:

true if the video loaded successfully, false otherwise.

Inherited Variables

Defined by Video

read onlycanPause:Bool

Indicates whether pausing is supported.

channel:Int

Selected audio channel.

chapter:Int

Current chapter of the video.

read onlychapterCount:Int

Total number of chapters in the video.

delay:Int64

Audio delay in microseconds.

read onlyduration:Int64

Duration of the media in microseconds.

@:value(false)forceRendering:Bool = false

Forces on the rendering of the bitmapData within this bitmap.

read onlyisPlaying:Bool

Indicates whether the media is currently playing.

read onlyisSeekable:Bool

Indicates whether seeking is supported.

read onlylength:Int64

Length of the media in microseconds.

read onlymrl:Null<String>

The media resource locator (MRL).

mute:Bool

Mute status of the audio.

+

WARNING: Must be set before loading a video.

@:value(true)autoVolumeHandle:Bool = true

Whether Flixel should automatically adjust the volume according to the Flixel sound system's current volume.

Methods

dynamicgetCalculatedVolume():Float

Calculates and returns the current volume based on Flixel's sound settings by default.

+

The volume is automatically clamped between 0 and 2.55 by the calling code. If the sound is muted, the volume is 0.

Returns:

The calculated volume.

load(location:Location, ?options:Array<String>):Bool

Loads a video.

Parameters:

location

The local filesystem path, the media location URL, the ID of an open file descriptor, or the bitstream input.

options

Additional options to add to the LibVLC Media.

Returns:

true if the video loaded successfully, false otherwise.

Inherited Variables

Defined by Video

read onlycanPause:Bool

Indicates whether pausing is supported.

channel:Int

Selected audio channel.

chapter:Int

Current chapter of the video.

read onlychapterCount:Int

Total number of chapters in the video.

delay:Int64

Audio delay in microseconds.

read onlyduration:Int64

Duration of the media in microseconds.

@:value(false)forceRendering:Bool = false

Forces on the rendering of the bitmapData within this bitmap.

read onlyisPlaying:Bool

Indicates whether the media is currently playing.

read onlyisSeekable:Bool

Indicates whether seeking is supported.

read onlylength:Int64

Length of the media in microseconds.

read onlymrl:Null<String>

The media resource locator (MRL).

mute:Bool

Mute status of the audio.

Note: May not be supported under certain conditions (e.g., digital pass-through).

@:value(new Event<Int>())read onlyonChapterChanged:_Event_Int_Void<Int ‑> Void> = new Event<Int>()

Event triggered when the chapter changes.

@:value(new Event<Void>())read onlyonCorked:_Event_Void_Void<() ‑> Void> = new Event<Void>()

Event triggered when the media is corked.

@:value(new Event<String>())read onlyonEncounteredError:_Event_String_Void<String ‑> Void> = new Event<String>()

Event triggered when an error occurs.

@:value(new Event<Void>())read onlyonEndReached:_Event_Void_Void<() ‑> Void> = new Event<Void>()

Event triggered when the end of the media is reached.

@:value(new Event<Void>())read onlyonFormatSetup:_Event_Void_Void<() ‑> Void> = new Event<Void>()

Event triggered when the format setup is initialized.

@:value(new Event<Int64>())read onlyonLengthChanged:_Event_haxe_Int64_Void<Int64 ‑> Void> = new Event<Int64>()

Event triggered when the length changes.

@:value(new Event<Void>())read onlyonMediaChanged:_Event_Void_Void<() ‑> Void> = new Event<Void>()

Event triggered when the media changes.

@:value(new Event<Void>())read onlyonMediaMetaChanged:_Event_Void_Void<() ‑> Void> = new Event<Void>()

Event triggered when the media metadata changes.

@:value(new Event<Int>())read onlyonMediaParsedChanged:_Event_Int_Void<Int ‑> Void> = new Event<Int>()

Event triggered when the media is parsed.

@:value(new Event<Void>())read onlyonOpening:_Event_Void_Void<() ‑> Void> = new Event<Void>()

Event triggered when the media is opening.

@:value(new Event<Void>())read onlyonPaused:_Event_Void_Void<() ‑> Void> = new Event<Void>()

Event triggered when playback is paused.

@:value(new Event<Void>())read onlyonPlaying:_Event_Void_Void<() ‑> Void> = new Event<Void>()

Event triggered when playback starts.

@:value(new Event<Single>())read onlyonPositionChanged:_Event_Single_Void<Single ‑> Void> = new Event<Single>()

Event triggered when the position changes.

@:value(new Event<Void>())read onlyonStopped:_Event_Void_Void<() ‑> Void> = new Event<Void>()

Event triggered when playback stops.

@:value(new Event<Int64>())read onlyonTimeChanged:_Event_haxe_Int64_Void<Int64 ‑> Void> = new Event<Int64>()

Event triggered when the time changes.

@:value(new Event<Void>())read onlyonUncorked:_Event_Void_Void<() ‑> Void> = new Event<Void>()

Event triggered when the media is uncorked.

write onlyoutput:String

Selected audio output module.

Note: Changes take effect only after restarting playback.

read onlyoutputModules:Null<Array<{name:String, description:String}>>

Available audio output modules.

position:Single

Current playback position as a percentage (0.0 to 1.0).

rate:Single

Playback rate of the video.

Note: The actual rate may vary depending on the media.

role:UInt

Role of the media.

read onlystats:Null<Stats>

Statistics related to the media.

time:Int64

Current time position in the media in microseconds.

track:Int

Selected audio track.

read onlytrackCount:Int

Total number of available audio tracks.

volume:Int

Volume level (0 to 100).

read onlywillPlay:Bool

Indicates whether playback will start automatically once loaded.

Defined by Bitmap

bitmapData:BitmapData

The BitmapData object being referenced.

pixelSnapping:PixelSnapping

Controls whether or not the Bitmap object is snapped to the nearest pixel. diff --git a/hxvlc/flixel/FlxVideoSprite.html b/hxvlc/flixel/FlxVideoSprite.html index e8ba5078b2..9c369aaf10 100644 --- a/hxvlc/flixel/FlxVideoSprite.html +++ b/hxvlc/flixel/FlxVideoSprite.html @@ -7,7 +7,7 @@ float: none; text-shadow: 0 0 0 transparent; } -

class FlxVideoSprite

package hxvlc.flixel

extends FlxSprite › FlxObject › FlxBasic

@:nullSafety

This class extends FlxSprite to display video files in HaxeFlixel.

+

class FlxVideoSprite

package hxvlc.flixel

extends FlxSprite › FlxObject › FlxBasic

@:nullSafety(Loose)@:nullSafety

This class extends FlxSprite to display video files in HaxeFlixel.

var video:FlxVideoSprite = new FlxVideoSprite(0, 0);
 video.antialiasing = true;
 video.bitmap.onFormatSetup.add(function():Void
@@ -27,7 +27,7 @@
 if (video.load('assets/videos/video.mp4'))
 	FlxTimer.wait(0.001, () -> video.play());

Constructor

@:value({ y : 0, x : 0 })new(x:Float = 0, y:Float = 0)

Creates a FlxVideoSprite at a specified position.

Parameters:

x

The initial X position of the sprite.

y

The initial Y position of the sprite.

Variables

@:value(FlxG.autoPause)autoPause:Bool = FlxG.autoPause

Indicates whether the video should automatically pause when focus is lost.

Must be set before loading a video.

@:value(true)autoVolumeHandle:Bool = true

Determines if Flixel automatically adjusts the volume based on the Flixel sound system's current volume.

read onlybitmap:Null<Video>

The video bitmap object.

Methods

dynamicgetCalculatedVolume():Float

Calculates and returns the current volume based on Flixel's sound settings by default.

-

The volume is automatically clamped between 0 and 1 by the calling code. If the sound is muted, the volume is 0.

Returns:

The calculated volume.

load(location:Location, ?options:Array<String>):Bool

Loads a video from the specified location.

Parameters:

location

The location of the media file or stream.

options

Additional options to configure the media.

Returns:

true if the media was loaded successfully, false otherwise.

inlineloadFromSubItem(index:Int, ?options:Array<String>):Bool

Loads a media subitem from the current media's subitems list at the specified index.

Parameters:

index

The index of the subitem to load.

options

Additional options to configure the loaded subitem.

Returns:

true if the subitem was loaded successfully, false otherwise.

inlineparseStop():Void

Stops parsing the current media item.

inlineparseWithOptions(parse_flag:Int, timeout:Int):Bool

Parses the current media item with the specified options.

Parameters:

parse_flag

The parsing option.

timeout

The timeout in milliseconds.

Returns:

true if parsing succeeded, false otherwise.

inlinepause():Void

Pauses video playback.

inlineplay():Bool

Starts video playback.

Returns:

true if playback started successfully, false otherwise.

inlineresume():Void

Resumes playback of a paused video.

inlinestop():Void

Stops video playback.

inlinetogglePaused():Void

Toggles between play and pause states of the video.

Inherited Variables

Defined by FlxSprite

@:value(1.0)alpha:Float = 1.0

Set alpha to a number between 0 and 1 to change the opacity of the sprite.

See also:

animation:FlxAnimationController

Class that handles adding and playing animations on this sprite.

See also:

@:value(defaultAntialiasing)antialiasing:Bool = defaultAntialiasing

Controls whether the object is smoothed when rotated, affects performance.

@:value(0)read onlybakedRotationAngle:Float = 0

The minimum angle (out of 360°) for which a new baked rotation exists. Example: 90 means there +

The volume is automatically clamped between 0 and 2.55 by the calling code. If the sound is muted, the volume is 0.

Returns:

The calculated volume.

load(location:Location, ?options:Array<String>):Bool

Loads a video from the specified location.

Parameters:

location

The location of the media file or stream.

options

Additional options to configure the media.

Returns:

true if the media was loaded successfully, false otherwise.

inlineloadFromSubItem(index:Int, ?options:Array<String>):Bool

Loads a media subitem from the current media's subitems list at the specified index.

Parameters:

index

The index of the subitem to load.

options

Additional options to configure the loaded subitem.

Returns:

true if the subitem was loaded successfully, false otherwise.

inlineparseStop():Void

Stops parsing the current media item.

inlineparseWithOptions(parse_flag:Int, timeout:Int):Bool

Parses the current media item with the specified options.

Parameters:

parse_flag

The parsing option.

timeout

The timeout in milliseconds.

Returns:

true if parsing succeeded, false otherwise.

inlinepause():Void

Pauses video playback.

inlineplay():Bool

Starts video playback.

Returns:

true if playback started successfully, false otherwise.

inlineresume():Void

Resumes playback of a paused video.

inlinestop():Void

Stops video playback.

inlinetogglePaused():Void

Toggles between play and pause states of the video.

Inherited Variables

Defined by FlxSprite

@:value(1.0)alpha:Float = 1.0

Set alpha to a number between 0 and 1 to change the opacity of the sprite.

See also:

animation:FlxAnimationController

Class that handles adding and playing animations on this sprite.

See also:

@:value(defaultAntialiasing)antialiasing:Bool = defaultAntialiasing

Controls whether the object is smoothed when rotated, affects performance.

@:value(0)read onlybakedRotationAngle:Float = 0

The minimum angle (out of 360°) for which a new baked rotation exists. Example: 90 means there are 4 baked rotations in the spritesheet. 0 if this sprite does not have any baked rotations.

See also:

blend:BlendMode

Blending modes, just like Photoshop or whatever, e.g. "multiply", "screen", etc.

clipRect:FlxRect

Clipping rectangle for this sprite. Changing the rect's properties directly doesn't have any effect, reassign the property to update it (sprite.clipRect = sprite.clipRect;). diff --git a/hxvlc/openfl/Stats.html b/hxvlc/openfl/Stats.html index 368b64b4bd..684cf7496a 100644 --- a/hxvlc/openfl/Stats.html +++ b/hxvlc/openfl/Stats.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

class Stats

package hxvlc.openfl

@:directlyUsed@:nullSafety

Represents various statistics related to media processing.

Static methods

staticfromMediaStats(media_stats:Struct<LibVLC_Media_Stats_T>):Stats

Constructs a Stats object from raw LibVLC media statistics.

Parameters:

media_stats

The structure to LibVLC media statistics.

Returns:

A Stats object populated with the provided media statistics.

Constructor

new()

Creates a new instance of Stats with default values.

Variables

f_demux_bitrate:Single

Bitrate of the demuxer in bits per second.

f_input_bitrate:Single

Bitrate of the input in bits per second.

f_send_bitrate:Single

Bitrate of the stream output in bits per second.

i_decoded_audio:Int

Number of audio frames decoded.

i_decoded_video:Int

Number of video frames decoded.

i_demux_corrupted:Int

Number of corrupted packets encountered by the demuxer.

i_demux_discontinuity:Int

Number of discontinuities encountered by the demuxer.

i_demux_read_bytes:Int

Number of bytes read by the demuxer.

i_displayed_pictures:Int

Number of pictures displayed.

i_lost_abuffers:Int

Number of audio buffers lost.

i_lost_pictures:Int

Number of pictures lost.

i_played_abuffers:Int

Number of audio buffers played.

i_read_bytes:Int

Number of bytes read from the input.

i_sent_bytes:Int

Number of bytes sent by the stream output.

i_sent_packets:Int

Number of packets sent by the stream output.

Methods

toString():String

Returns a string representation of the Stats object.

Returns:

A string containing all the properties of the Stats object.

© 2024  

\ No newline at end of file +

class Stats

package hxvlc.openfl

@:directlyUsed@:nullSafety(Loose)

Represents various statistics related to media processing.

Static methods

staticfromMediaStats(media_stats:Struct<LibVLC_Media_Stats_T>):Stats

Constructs a Stats object from raw LibVLC media statistics.

Parameters:

media_stats

The structure to LibVLC media statistics.

Returns:

A Stats object populated with the provided media statistics.

Constructor

new()

Creates a new instance of Stats with default values.

Variables

f_demux_bitrate:Single

Bitrate of the demuxer in bits per second.

f_input_bitrate:Single

Bitrate of the input in bits per second.

f_send_bitrate:Single

Bitrate of the stream output in bits per second.

i_decoded_audio:Int

Number of audio frames decoded.

i_decoded_video:Int

Number of video frames decoded.

i_demux_corrupted:Int

Number of corrupted packets encountered by the demuxer.

i_demux_discontinuity:Int

Number of discontinuities encountered by the demuxer.

i_demux_read_bytes:Int

Number of bytes read by the demuxer.

i_displayed_pictures:Int

Number of pictures displayed.

i_lost_abuffers:Int

Number of audio buffers lost.

i_lost_pictures:Int

Number of pictures lost.

i_played_abuffers:Int

Number of audio buffers played.

i_read_bytes:Int

Number of bytes read from the input.

i_sent_bytes:Int

Number of bytes sent by the stream output.

i_sent_packets:Int

Number of packets sent by the stream output.

Methods

toString():String

Returns a string representation of the Stats object.

Returns:

A string containing all the properties of the Stats object.

© 2024  

\ No newline at end of file diff --git a/hxvlc/openfl/Video.html b/hxvlc/openfl/Video.html index e6cb9174cc..1930f270e4 100644 --- a/hxvlc/openfl/Video.html +++ b/hxvlc/openfl/Video.html @@ -7,7 +7,7 @@ float: none; text-shadow: 0 0 0 transparent; } -

class Video

package hxvlc.openfl

extends Bitmap › DisplayObject › EventDispatcher

extended by FlxVideo

@:directlyUsed@:nullSafety@:cppNamespaceCode("static int media_open(void *opaque, void **datap, uint64_t *sizep)\n{\n\thx::SetTopOfStack((int *)99, true);\n\n\tVideo_obj *self = reinterpret_cast<Video_obj *>(opaque);\n\n\tself->mediaMutex->acquire();\n\n\t(*datap) = opaque;\n\t(*sizep) = self->mediaSize;\n\n\tself->mediaMutex->release();\n\n\thx::SetTopOfStack((int *)0, true);\n\n\treturn 0;\n}\n\nstatic ssize_t media_read(void *opaque, unsigned char *buf, size_t len)\n{\n\thx::SetTopOfStack((int *)99, true);\n\n\tVideo_obj *self = reinterpret_cast<Video_obj *>(opaque);\n\n\tself->mediaMutex->acquire();\n\n\tif (self->mediaOffset >= self->mediaSize)\n\t{\n\t\tself->mediaMutex->release();\n\n\t\thx::SetTopOfStack((int *)0, true);\n\n\t\treturn 0;\n\t}\n\n\tuint64_t toRead = len < (self->mediaSize - self->mediaOffset) ? len : (self->mediaSize - self->mediaOffset);\n\n\tif (self->mediaData == NULL || (self->mediaOffset > self->mediaSize - toRead))\n\t{\n\t\tself->mediaMutex->release();\n\n\t\thx::SetTopOfStack((int *)0, true);\n\n\t\treturn -1;\n\t}\n\n\tmemcpy(buf, &self->mediaData[self->mediaOffset], (size_t)toRead);\n\n\tself->mediaOffset += toRead;\n\n\tself->mediaMutex->release();\n\n\thx::SetTopOfStack((int *)0, true);\n\n\treturn (ssize_t)toRead;\n}\n\nstatic int media_seek(void *opaque, uint64_t offset)\n{\n\thx::SetTopOfStack((int *)99, true);\n\n\tVideo_obj *self = reinterpret_cast<Video_obj *>(opaque);\n\n\tself->mediaMutex->acquire();\n\n\tif (offset > self->mediaSize)\n\t{\n\t\tself->mediaMutex->release();\n\n\t\thx::SetTopOfStack((int *)0, true);\n\n\t\treturn -1;\n\t}\n\n\tself->mediaOffset = offset;\n\n\tself->mediaMutex->release();\n\n\thx::SetTopOfStack((int *)0, true);\n\n\treturn 0;\n}\n\nstatic void *video_lock(void *opaque, void **planes)\n{\n\thx::SetTopOfStack((int *)99, true);\n\n\tvoid *picture = reinterpret_cast<Video_obj *>(opaque)->videoLock(planes);\n\n\thx::SetTopOfStack((int *)0, true);\n\n\treturn picture;\n}\n\nstatic void video_unlock(void *opaque, void *picture, void *const *planes)\n{\n\thx::SetTopOfStack((int *)99, true);\n\n\treinterpret_cast<Video_obj *>(opaque)->videoUnlock(planes);\n\n\thx::SetTopOfStack((int *)0, true);\n}\n\nstatic void video_display(void *opaque, void *picture)\n{\n\thx::SetTopOfStack((int *)99, true);\n\n\treinterpret_cast<Video_obj *>(opaque)->videoDisplay(picture);\n\n\thx::SetTopOfStack((int *)0, true);\n}\n\nstatic unsigned video_format_setup(void **opaque, char *chroma, unsigned *width, unsigned *height, unsigned *pitches, unsigned *lines)\n{\n\thx::SetTopOfStack((int *)99, true);\n\n\tint pictureBuffers = reinterpret_cast<Video_obj *>(*opaque)->videoFormatSetup(chroma, width, height, pitches, lines);\n\n\thx::SetTopOfStack((int *)0, true);\n\n\treturn pictureBuffers;\n}\n\nstatic void audio_play(void *data, const void *samples, unsigned count, int64_t pts)\n{\n\thx::SetTopOfStack((int *)99, true);\n\n\treinterpret_cast<Video_obj *>(data)->audioPlay((unsigned char *)samples, count, pts);\n\n\thx::SetTopOfStack((int *)0, true);\n}\n\nstatic void audio_pause(void *data, int64_t pts)\n{\n\thx::SetTopOfStack((int *)99, true);\n\n\treinterpret_cast<Video_obj *>(data)->audioPause(pts);\n\n\thx::SetTopOfStack((int *)0, true);\n}\n\nstatic void audio_resume(void *data, int64_t pts)\n{\n\thx::SetTopOfStack((int *)99, true);\n\n\treinterpret_cast<Video_obj *>(data)->audioResume(pts);\n\n\thx::SetTopOfStack((int *)0, true);\n}\n\nstatic int audio_setup(void **data, char *format, unsigned *rate, unsigned *channels)\n{\n\thx::SetTopOfStack((int *)99, true);\n\n\tint success = reinterpret_cast<Video_obj *>(*data)->audioSetup(format, rate, channels);\n\n\thx::SetTopOfStack((int *)0, true);\n\n\treturn success;\n}\n\nstatic void audio_set_volume(void *data, float volume, bool mute)\n{\n\thx::SetTopOfStack((int *)99, true);\n\n\treinterpret_cast<Video_obj *>(data)->audioSetVolume(volume, mute);\n\n\thx::SetTopOfStack((int *)0, true);\n}\n\nstatic void event_manager_callbacks(const libvlc_event_t *p_event, void *p_data)\n{\n\thx::SetTopOfStack((int *)99, true);\n\n\tVideo_obj *self = reinterpret_cast<Video_obj *>(p_data);\n\n\tself->eventsMutex->acquire();\n\n\tswitch (p_event->type)\n\t{\n\tcase libvlc_MediaPlayerOpening:\n\t\tself->events[0] = true;\n\t\tbreak;\n\tcase libvlc_MediaPlayerPlaying:\n\t\tself->events[1] = true;\n\t\tbreak;\n\tcase libvlc_MediaPlayerStopped:\n\t\tself->events[2] = true;\n\t\tbreak;\n\tcase libvlc_MediaPlayerPaused:\n\t\tself->events[3] = true;\n\t\tbreak;\n\tcase libvlc_MediaPlayerEndReached:\n\t\tself->events[4] = true;\n\t\tbreak;\n\tcase libvlc_MediaPlayerEncounteredError:\n\t\tself->events[5] = true;\n\t\tbreak;\n\tcase libvlc_MediaPlayerMediaChanged:\n\t\tself->events[6] = true;\n\t\tbreak;\n\tcase libvlc_MediaPlayerCorked:\n\t\tself->events[7] = true;\n\t\tbreak;\n\tcase libvlc_MediaPlayerUncorked:\n\t\tself->events[8] = true;\n\t\tbreak;\n\tcase libvlc_MediaPlayerTimeChanged:\n\t\tself->events[9] = true;\n\t\tbreak;\n\tcase libvlc_MediaPlayerPositionChanged:\n\t\tself->events[10] = true;\n\t\tbreak;\n\tcase libvlc_MediaPlayerLengthChanged:\n\t\tself->events[11] = true;\n\t\tbreak;\n\tcase libvlc_MediaPlayerChapterChanged:\n\t\tself->events[12] = true;\n\t\tbreak;\n\tcase libvlc_MediaMetaChanged:\n\t\tself->events[13] = true;\n\t\tbreak;\n\tcase libvlc_MediaParsedChanged:\n\t\tself->events[14] = true;\n\t\tbreak;\n\t}\n\n\tself->eventsMutex->release();\n\n\thx::SetTopOfStack((int *)0, true);\n}")

This class is a video player that uses LibVLC for seamless integration with OpenFL display objects.

Static variables

@:value(true)staticuseTexture:Bool = true

Indicates whether to use GPU texture for rendering.

+

class Video

package hxvlc.openfl

extends Bitmap › DisplayObject › EventDispatcher

extended by FlxVideo

@:directlyUsed@:nullSafety(Loose)@:cppNamespaceCode("static int media_open(void *opaque, void **datap, uint64_t *sizep)\n{\n\thx::SetTopOfStack((int *)99, true);\n\n\tVideo_obj *self = reinterpret_cast<Video_obj *>(opaque);\n\n\tself->mediaMutex->acquire();\n\n\t(*datap) = opaque;\n\t(*sizep) = self->mediaSize;\n\n\tself->mediaMutex->release();\n\n\thx::SetTopOfStack((int *)0, true);\n\n\treturn 0;\n}\n\nstatic ssize_t media_read(void *opaque, unsigned char *buf, size_t len)\n{\n\thx::SetTopOfStack((int *)99, true);\n\n\tVideo_obj *self = reinterpret_cast<Video_obj *>(opaque);\n\n\tself->mediaMutex->acquire();\n\n\tif (self->mediaOffset >= self->mediaSize)\n\t{\n\t\tself->mediaMutex->release();\n\n\t\thx::SetTopOfStack((int *)0, true);\n\n\t\treturn 0;\n\t}\n\n\tuint64_t toRead = len < (self->mediaSize - self->mediaOffset) ? len : (self->mediaSize - self->mediaOffset);\n\n\tif (self->mediaData == NULL || (self->mediaOffset > self->mediaSize - toRead))\n\t{\n\t\tself->mediaMutex->release();\n\n\t\thx::SetTopOfStack((int *)0, true);\n\n\t\treturn -1;\n\t}\n\n\tmemcpy(buf, &self->mediaData[self->mediaOffset], (size_t)toRead);\n\n\tself->mediaOffset += toRead;\n\n\tself->mediaMutex->release();\n\n\thx::SetTopOfStack((int *)0, true);\n\n\treturn (ssize_t)toRead;\n}\n\nstatic int media_seek(void *opaque, uint64_t offset)\n{\n\thx::SetTopOfStack((int *)99, true);\n\n\tVideo_obj *self = reinterpret_cast<Video_obj *>(opaque);\n\n\tself->mediaMutex->acquire();\n\n\tif (offset > self->mediaSize)\n\t{\n\t\tself->mediaMutex->release();\n\n\t\thx::SetTopOfStack((int *)0, true);\n\n\t\treturn -1;\n\t}\n\n\tself->mediaOffset = offset;\n\n\tself->mediaMutex->release();\n\n\thx::SetTopOfStack((int *)0, true);\n\n\treturn 0;\n}\n\nstatic void *video_lock(void *opaque, void **planes)\n{\n\thx::SetTopOfStack((int *)99, true);\n\n\tvoid *picture = reinterpret_cast<Video_obj *>(opaque)->videoLock(planes);\n\n\thx::SetTopOfStack((int *)0, true);\n\n\treturn picture;\n}\n\nstatic void video_unlock(void *opaque, void *picture, void *const *planes)\n{\n\thx::SetTopOfStack((int *)99, true);\n\n\treinterpret_cast<Video_obj *>(opaque)->videoUnlock(planes);\n\n\thx::SetTopOfStack((int *)0, true);\n}\n\nstatic void video_display(void *opaque, void *picture)\n{\n\thx::SetTopOfStack((int *)99, true);\n\n\treinterpret_cast<Video_obj *>(opaque)->videoDisplay(picture);\n\n\thx::SetTopOfStack((int *)0, true);\n}\n\nstatic unsigned video_format_setup(void **opaque, char *chroma, unsigned *width, unsigned *height, unsigned *pitches, unsigned *lines)\n{\n\thx::SetTopOfStack((int *)99, true);\n\n\tint pictureBuffers = reinterpret_cast<Video_obj *>(*opaque)->videoFormatSetup(chroma, width, height, pitches, lines);\n\n\thx::SetTopOfStack((int *)0, true);\n\n\treturn pictureBuffers;\n}\n\nstatic void audio_play(void *data, const void *samples, unsigned count, int64_t pts)\n{\n\thx::SetTopOfStack((int *)99, true);\n\n\treinterpret_cast<Video_obj *>(data)->audioPlay((unsigned char *)samples, count, pts);\n\n\thx::SetTopOfStack((int *)0, true);\n}\n\nstatic void audio_pause(void *data, int64_t pts)\n{\n\thx::SetTopOfStack((int *)99, true);\n\n\treinterpret_cast<Video_obj *>(data)->audioPause(pts);\n\n\thx::SetTopOfStack((int *)0, true);\n}\n\nstatic void audio_resume(void *data, int64_t pts)\n{\n\thx::SetTopOfStack((int *)99, true);\n\n\treinterpret_cast<Video_obj *>(data)->audioResume(pts);\n\n\thx::SetTopOfStack((int *)0, true);\n}\n\nstatic int audio_setup(void **data, char *format, unsigned *rate, unsigned *channels)\n{\n\thx::SetTopOfStack((int *)99, true);\n\n\tint success = reinterpret_cast<Video_obj *>(*data)->audioSetup(format, rate, channels);\n\n\thx::SetTopOfStack((int *)0, true);\n\n\treturn success;\n}\n\nstatic void audio_set_volume(void *data, float volume, bool mute)\n{\n\thx::SetTopOfStack((int *)99, true);\n\n\treinterpret_cast<Video_obj *>(data)->audioSetVolume(volume, mute);\n\n\thx::SetTopOfStack((int *)0, true);\n}\n\nstatic void event_manager_callbacks(const libvlc_event_t *p_event, void *p_data)\n{\n\thx::SetTopOfStack((int *)99, true);\n\n\treinterpret_cast<Video_obj *>(p_data)->eventManagerCallbacks(p_event);\n\n\thx::SetTopOfStack((int *)0, true);\n}")

This class is a video player that uses LibVLC for seamless integration with OpenFL display objects.

Static variables

@:value(true)staticuseTexture:Bool = true

Indicates whether to use GPU texture for rendering.

If set to true, GPU texture rendering will be used if possible, otherwise, CPU-based image rendering will be used.

Constructor

@:value({ smoothing : true })new(smoothing:Bool = true)

Initializes a Video object.

Parameters:

smoothing

Whether or not the object is smoothed when scaled.

Variables

read onlycanPause:Bool

Indicates whether pausing is supported.

channel:Int

Selected audio channel.

chapter:Int

Current chapter of the video.

read onlychapterCount:Int

Total number of chapters in the video.

delay:Int64

Audio delay in microseconds.

read onlyduration:Int64

Duration of the media in microseconds.

@:value(false)forceRendering:Bool = false

Forces on the rendering of the bitmapData within this bitmap.

read onlyisPlaying:Bool

Indicates whether the media is currently playing.

read onlyisSeekable:Bool

Indicates whether seeking is supported.

read onlylength:Int64

Length of the media in microseconds.

read onlymrl:Null<String>

The media resource locator (MRL).

mute:Bool

Mute status of the audio.

Note: May not be supported under certain conditions (e.g., digital pass-through).

@:value(new Event<Int>())read onlyonChapterChanged:_Event_Int_Void<Int ‑> Void> = new Event<Int>()

Event triggered when the chapter changes.

@:value(new Event<Void>())read onlyonCorked:_Event_Void_Void<() ‑> Void> = new Event<Void>()

Event triggered when the media is corked.

@:value(new Event<String>())read onlyonEncounteredError:_Event_String_Void<String ‑> Void> = new Event<String>()

Event triggered when an error occurs.

@:value(new Event<Void>())read onlyonEndReached:_Event_Void_Void<() ‑> Void> = new Event<Void>()

Event triggered when the end of the media is reached.

@:value(new Event<Void>())read onlyonFormatSetup:_Event_Void_Void<() ‑> Void> = new Event<Void>()

Event triggered when the format setup is initialized.

@:value(new Event<Int64>())read onlyonLengthChanged:_Event_haxe_Int64_Void<Int64 ‑> Void> = new Event<Int64>()

Event triggered when the length changes.

@:value(new Event<Void>())read onlyonMediaChanged:_Event_Void_Void<() ‑> Void> = new Event<Void>()

Event triggered when the media changes.

@:value(new Event<Void>())read onlyonMediaMetaChanged:_Event_Void_Void<() ‑> Void> = new Event<Void>()

Event triggered when the media metadata changes.

@:value(new Event<Int>())read onlyonMediaParsedChanged:_Event_Int_Void<Int ‑> Void> = new Event<Int>()

Event triggered when the media is parsed.

@:value(new Event<Void>())read onlyonOpening:_Event_Void_Void<() ‑> Void> = new Event<Void>()

Event triggered when the media is opening.

@:value(new Event<Void>())read onlyonPaused:_Event_Void_Void<() ‑> Void> = new Event<Void>()

Event triggered when playback is paused.

@:value(new Event<Void>())read onlyonPlaying:_Event_Void_Void<() ‑> Void> = new Event<Void>()

Event triggered when playback starts.

@:value(new Event<Single>())read onlyonPositionChanged:_Event_Single_Void<Single ‑> Void> = new Event<Single>()

Event triggered when the position changes.

@:value(new Event<Void>())read onlyonStopped:_Event_Void_Void<() ‑> Void> = new Event<Void>()

Event triggered when playback stops.

@:value(new Event<Int64>())read onlyonTimeChanged:_Event_haxe_Int64_Void<Int64 ‑> Void> = new Event<Int64>()

Event triggered when the time changes.

@:value(new Event<Void>())read onlyonUncorked:_Event_Void_Void<() ‑> Void> = new Event<Void>()

Event triggered when the media is uncorked.

write onlyoutput:String

Selected audio output module.

Note: Changes take effect only after restarting playback.

read onlyoutputModules:Null<Array<{name:String, description:String}>>

Available audio output modules.

position:Single

Current playback position as a percentage (0.0 to 1.0).

rate:Single

Playback rate of the video.

diff --git a/hxvlc/util/Handle.html b/hxvlc/util/Handle.html index 94e91240d2..ae997bed86 100644 --- a/hxvlc/util/Handle.html +++ b/hxvlc/util/Handle.html @@ -7,7 +7,7 @@ float: none; text-shadow: 0 0 0 transparent; } -

class Handle

package hxvlc.util

@:directlyUsed@:nullSafety@:cppNamespaceCode("static void instance_logging(void *data, int level, const libvlc_log_t *ctx, const char *fmt, va_list args)\n{\n\thx::SetTopOfStack((int *)99, true);\n\n#ifdef __ANDROID__\n\tswitch (level)\n\t{\n\tcase LIBVLC_NOTICE:\n\t\t__android_log_vprint(ANDROID_LOG_INFO, \"HXVLC\", fmt, args);\n\t\tbreak;\n\tcase LIBVLC_ERROR:\n\t\t__android_log_vprint(ANDROID_LOG_ERROR, \"HXVLC\", fmt, args);\n\t\tbreak;\n\tcase LIBVLC_WARNING:\n\t\t__android_log_vprint(ANDROID_LOG_WARN, \"HXVLC\", fmt, args);\n\t\tbreak;\n\tcase LIBVLC_DEBUG:\n\t\t__android_log_vprint(ANDROID_LOG_DEBUG, \"HXVLC\", fmt, args);\n\t\tbreak;\n\tdefault:\n\t\t__android_log_vprint(ANDROID_LOG_UNKNOWN, \"HXVLC\", fmt, args);\n\t\tbreak;\n\t}\n#else\n\tvprintf(fmt, args);\n\tprintf(\"\\n\");\n#endif\n\n\thx::SetTopOfStack((int *)0, true);\n}")

This class manages the global instance of LibVLC, providing methods for initialization, disposal, and retrieving version information.

Static variables

staticread onlychangeset:String

Retrieves the LibVLC changeset.

+

class Handle

package hxvlc.util

@:directlyUsed@:nullSafety(Loose)@:cppNamespaceCode("static void instance_logging(void *data, int level, const libvlc_log_t *ctx, const char *fmt, va_list args)\n{\n\thx::SetTopOfStack((int *)99, true);\n\n#ifdef __ANDROID__\n\tswitch (level)\n\t{\n\tcase LIBVLC_NOTICE:\n\t\t__android_log_vprint(ANDROID_LOG_INFO, \"HXVLC\", fmt, args);\n\t\tbreak;\n\tcase LIBVLC_ERROR:\n\t\t__android_log_vprint(ANDROID_LOG_ERROR, \"HXVLC\", fmt, args);\n\t\tbreak;\n\tcase LIBVLC_WARNING:\n\t\t__android_log_vprint(ANDROID_LOG_WARN, \"HXVLC\", fmt, args);\n\t\tbreak;\n\tcase LIBVLC_DEBUG:\n\t\t__android_log_vprint(ANDROID_LOG_DEBUG, \"HXVLC\", fmt, args);\n\t\tbreak;\n\tdefault:\n\t\t__android_log_vprint(ANDROID_LOG_UNKNOWN, \"HXVLC\", fmt, args);\n\t\tbreak;\n\t}\n#else\n\tvprintf(fmt, args);\n\tprintf(\"\\n\");\n#endif\n\n\thx::SetTopOfStack((int *)0, true);\n}")

This class manages the global instance of LibVLC, providing methods for initialization, disposal, and retrieving version information.

Static variables

staticread onlychangeset:String

Retrieves the LibVLC changeset.

Example: "aa9bce0bc4"

staticread onlyclock:Int64

Returns the current time as defined by LibVLC.

The unit is the microsecond.

Time increases monotonically (regardless of time zone changes and RTC adjustments).

diff --git a/hxvlc/util/Location.html b/hxvlc/util/Location.html index 2568b7231d..7e4ceb8812 100644 --- a/hxvlc/util/Location.html +++ b/hxvlc/util/Location.html @@ -7,7 +7,7 @@ float: none; text-shadow: 0 0 0 transparent; } -

typedef Location

package hxvlc.util

Represents a location which can be:

sourceChannel

The source channel. Use a value from the -BitmapDataChannel class

-
				   (`BitmapDataChannel.RED`,
-
-

BitmapDataChannel.BLUE, +the destination image, specify a point other than +(0,0).

sourceChannel

The source channel. Use a value from the +BitmapDataChannel class +(BitmapDataChannel.RED, +BitmapDataChannel.BLUE, BitmapDataChannel.GREEN, BitmapDataChannel.ALPHA).

destChannel

The destination channel. Use a value from the -BitmapDataChannel class

-
				   (`BitmapDataChannel.RED`,
-
-

BitmapDataChannel.BLUE, +BitmapDataChannel class +(BitmapDataChannel.RED, +BitmapDataChannel.BLUE, BitmapDataChannel.GREEN, BitmapDataChannel.ALPHA).

Throws:

TypeError

The sourceBitmapData, sourceRect or destPoint are null.

See also:

@:value({ mergeAlpha : false, alphaPoint : null, alphaBitmapData : null })copyPixels(sourceBitmapData:BitmapData, sourceRect:Rectangle, destPoint:Point, ?alphaBitmapData:BitmapData, ?alphaPoint:Point, mergeAlpha:Bool = false):Void

Provides a fast routine to perform pixel manipulation between images with no stretching, rotation, or color effects. This method copies a @@ -436,10 +433,10 @@ considered opaque in the second BitmapData object. Use this parameter only when the value of secondObject is a BitmapData object and both BitmapData objects are transparent.

Returns:

A value of true if a hit occurs; otherwise, false.

Throws:

ArgumentError

The secondObject parameter is not a Point, Rectangle, -Bitmap, or BitmapData object.

TypeError

The firstPoint is null.

lock():Void

When targeting AIR, this method locks an image so that any objects -that reference the BitmapData object, such as Bitmap objects, are not -updated when this BitmapData object changes. To improve performance, -use this method along with the unlock() method before and after numerous +Bitmap, or BitmapData object.

TypeError

The firstPoint is null.

lock():Void

When targeting AIR, this method locks an image so that any objects +that reference the BitmapData object, such as Bitmap objects, are not +updated when this BitmapData object changes. To improve performance, +use this method along with the unlock() method before and after numerous calls to the setPixel() or setPixel32() method.

Note: This method only provides an optimization on the AIR(Flash) target. For all other targets, this method contains an empty function body.

merge(sourceBitmapData:BitmapData, sourceRect:Rectangle, destPoint:Point, redMultiplier:UInt, greenMultiplier:UInt, blueMultiplier:UInt, alphaMultiplier:UInt):Void

Performs per-channel blending from a source image to a destination image. For @@ -629,8 +626,8 @@ destination when the threshold test fails. If the value is false, the source image is not copied when the threshold test fails.

Returns:

The number of pixels that were changed.

Throws:

ArgumentError

The operation string is not a valid operation

TypeError

The sourceBitmapData, sourceRect destPoint or -operation are null.

@:value({ changeRect : null })unlock(?changeRect:Rectangle):Void

When targeting AIR, this method Unlocks an image so that any objects that reference -the BitmapData object, such as Bitmap objects, are updated when this BitmapData object +operation are null.

@:value({ changeRect : null })unlock(?changeRect:Rectangle):Void

When targeting AIR, this method Unlocks an image so that any objects that reference +the BitmapData object, such as Bitmap objects, are updated when this BitmapData object changes.

To improve performance, use this method along with the lock() method before and after numerous calls to the setPixel() or diff --git a/openfl/display/Graphics.html b/openfl/display/Graphics.html index 7ffd557b62..e5c3bef930 100644 --- a/openfl/display/Graphics.html +++ b/openfl/display/Graphics.html @@ -34,10 +34,7 @@ example, you can use the following matrix to rotate a bitmap by 45 degrees(pi/4 radians):

matrix = new openfl.geom.Matrix();
-	 	matrix.rotate(Math.PI / 4);
-	 	```
-
-
repeat

If true, the bitmap image repeats in a tiled +matrix.rotate(Math.PI / 4);repeat

If true, the bitmap image repeats in a tiled pattern. If false, the bitmap image does not repeat, and the edges of the bitmap are used for any fill area that extends beyond the bitmap.

@@ -200,7 +197,7 @@ anchor point relative to the registration point of the parent display object.

See also:

drawCircle(x:Float, y:Float, radius:Float):Void

See also:

drawEllipse(x:Float, y:Float, width:Float, height:Float):Void

Draws an ellipse. Set the line style, fill, or both before you call the drawEllipse() method, by calling the -linestyle(), lineGradientStyle(), +lineStyle(), lineGradientStyle(), beginFill(), beginGradientFill(), or beginBitmapFill() method.

Parameters:

x

The x location of the top-left of the bounding-box of the ellipse relative to the registration point of the parent @@ -264,24 +261,22 @@ matrix [ a, b, c, d, ... ] values. A transforms object which is six times the draw count in size will use full matrix [ a, b, c, d, tx, ty, ... ] values per draw.

drawRect(x:Float, y:Float, width:Float, height:Float):Void

Draws a rectangle. Set the line style, fill, or both before you call the -drawRect() method, by calling the linestyle(), +drawRect() method, by calling the lineStyle(), lineGradientStyle(), beginFill(), beginGradientFill(), or beginBitmapFill() method.

Parameters:

x

A number indicating the horizontal position relative to the registration point of the parent display object (in pixels).

y

A number indicating the vertical position relative to the registration point of the parent display object (in pixels).

width

The width of the rectangle (in pixels).

height

The height of the rectangle (in pixels).

Throws:

ArgumentError

If the width or height -parameters are not a number

-
				 (`Number.NaN`).
-

See also:

@:value({ ellipseHeight : null })drawRoundRect(x:Float, y:Float, width:Float, height:Float, ellipseWidth:Float, ?ellipseHeight:Float):Void

Draws a rounded rectangle. Set the line style, fill, or both before you +parameters are not a number +(Number.NaN).

See also:

@:value({ ellipseHeight : null })drawRoundRect(x:Float, y:Float, width:Float, height:Float, ellipseWidth:Float, ?ellipseHeight:Float):Void

Draws a rounded rectangle. Set the line style, fill, or both before you call the drawRoundRect() method, by calling the -linestyle(), lineGradientStyle(), +lineStyle(), lineGradientStyle(), beginFill(), beginGradientFill(), or beginBitmapFill() method.

Parameters:

x

A number indicating the horizontal position relative to the registration point of the parent display object(in pixels).

y

A number indicating the vertical position relative to -the registration point of the parent display object

-
				(in pixels).
-
width

The width of the round rectangle (in pixels).

height

The height of the round rectangle (in pixels).

ellipseWidth

The width of the ellipse used to draw the rounded +the registration point of the parent display object +(in pixels).

width

The width of the round rectangle (in pixels).

height

The height of the round rectangle (in pixels).

ellipseWidth

The width of the ellipse used to draw the rounded corners(in pixels).

ellipseHeight

The height of the ellipse used to draw the rounded corners(in pixels). Optional; if no value is specified, the default value matches that provided @@ -386,9 +381,8 @@ thickness; the maximum thickness is 255. If a value greater than 255 is passed, the default is 255.

color

A hexadecimal color value of the line; for example, red is 0xFF0000, blue is 0x0000FF, and so on. If a -value is not indicated, the default is 0x000000

-
			   (black). Optional.
-
alpha

A number that indicates the alpha value of the color +value is not indicated, the default is 0x000000 +(black). Optional.

alpha

A number that indicates the alpha value of the color of the line; valid values are 0 to 1. If a value is not indicated, the default is 1 (solid). If the value is less than 0, the default is 0. If the value is @@ -404,19 +398,16 @@ Flash Player or Adobe AIR renders two rounded rectangles that are identical, except that the pixelHinting parameter used in the -lineStyle() method is set differently

-
			   (the images are scaled by 200%, to emphasize the
-
-

difference):

+lineStyle() method is set differently +(the images are scaled by 200%, to emphasize the +difference):

pixelHinting false and pixelHinting true

If a value is not supplied, the line does not use pixel hinting.

scaleMode

(Not supported in Flash Lite 4) A value from the LineScaleMode class that specifies which scale mode to -use:

  • -

    LineScaleMode.NORMAL - Always -scale the line thickness when the object is scaled

    -
    		   (the default).
-
  • LineScaleMode.NONE - Never scale +use:

    • LineScaleMode.NORMAL - Always +scale the line thickness when the object is scaled +(the default).
    • LineScaleMode.NONE - Never scale the line thickness.
    • LineScaleMode.VERTICAL - Do not scale the line thickness if the object is scaled vertically only. For example, consider the diff --git a/openfl/display/GraphicsStroke.html b/openfl/display/GraphicsStroke.html index dacbc9942b..bee8d9a82e 100644 --- a/openfl/display/GraphicsStroke.html +++ b/openfl/display/GraphicsStroke.html @@ -25,17 +25,14 @@ illustrations show how Flash Player renders two rounded rectangles that are identical, except that the pixelHinting parameter used in the -lineStyle() method is set differently

      -
      			   (the images are scaled by 200%, to emphasize the
-
      -

      difference):

      +lineStyle() method is set differently +(the images are scaled by 200%, to emphasize the +difference):

      If a value is not supplied, the line does not use pixel hinting.

scaleMode

A value from the LineScaleMode class that specifies -which scale mode to use: