DanmakuFlameMaster Documentation

To include DanmakuFlameMaster in your Android project using Gradle, add the jcenter() repository and the following dependencies. Note that ndkbitmap-armv7a is required, while other ABIs are optional depending on your target architecture.

repositories {
    jcenter()
}

dependencies {
    compile 'com.github.ctiao:DanmakuFlameMaster:0.9.25'
    compile 'com.github.ctiao:ndkbitmap-armv7a:0.9.21'

    # Other ABIs: optional
    compile 'com.github.ctiao:ndkbitmap-armv5:0.9.21'
    compile 'com.github.ctiao:ndkbitmap-x86:0.9.21'
}

To include DanmakuFlameMaster in your project using Maven, add the following dependency to your pom.xml file.

<dependency>
  <groupId>com.github.ctiao</groupId>
  <artifactId>dfm</artifactId>
  <version>0.9.25</version>
</dependency>

The IDanmakus interface provides several comparator classes for sorting BaseDanmaku objects. All comparators support an optional duplicateMergingEnabled flag via their constructor to treat duplicate danmaku as equal (returning 0 in compare).

Available Comparators

• TimeComparator(boolean duplicateMergingEnabled): Sorts danmaku by time.
• YPosComparator(boolean duplicateMergingEnabled): Sorts danmaku by their vertical position (getTop()) in ascending order.
• YPosDescComparator(boolean duplicateMergingEnabled): Sorts danmaku by their vertical position (getTop()) in descending order.

When using forEach or forEachSync on an IDanmakus instance, you can provide an implementation of IDanmakus.Consumer. The accept method determines the flow of the loop by returning an action constant.

Action Constants

• ACTION_CONTINUE (0): Continue the loop.
• ACTION_BREAK (1): Stop the loop.
• ACTION_REMOVE (2): Remove the current item and continue.
• ACTION_REMOVE_AND_BREAK (3): Remove the current item and stop the loop.

To implement custom danmaku rendering logic, implement the IRenderer interface. The interface provides methods for drawing danmaku, managing the lifecycle of the renderer, and handling listeners.

Key methods to implement:

• draw(IDisplayer disp, IDanmakus danmaku, long startRenderTime, RenderingState renderingState): The core method for rendering a collection of danmakus.
• clear(): Clears the current rendering state.
• clearRetainer(): Clears the retainer.
• release(): Releases resources used by the renderer.

Rendering types are defined by constants:

• NOTHING_RENDERING (0)
• CACHE_RENDERING (1)
• TEXT_RENDERING (2)

public interface IRenderer {
    void draw(IDisplayer disp, IDanmakus danmaku, long startRenderTime, RenderingState renderingState);
    void clear();
    void clearRetainer();
    void release();
    // ... other methods
}

The IRenderer interface provides several configuration methods to control its behavior and interaction with other components:

• setCacheManager(ICacheManager cacheManager): Sets the manager used for caching.
• setVerifierEnabled(boolean enabled): Enables or disables the verifier.
• setOnDanmakuShownListener(OnDanmakuShownListener onDanmakuShownListener): Sets a listener that triggers onDanmakuShown(BaseDanmaku danmaku) when a danmaku is displayed.
• removeOnDanmakuShownListener(): Removes the current listener.
• alignBottom(boolean enable): Enables or disables bottom alignment.

The Area class defines the rectangular region used for rendering and refresh updates.

Key methods:

• set(float left, float top, float right, float bottom): Sets the specific coordinates for the area.
• setEdge(int maxWidth, int maxHeight): Sets the maximum boundaries for the area.
• reset(): Resets the area to the maximum width and height.
• resizeToMax(): Resizes the area to fill the maximum width and height.

The mRefreshRect field (a float[4]) stores the current boundaries as [left, top, right, bottom].

The RenderingState class is used to track the current state and statistics of the rendering process. It can be used to monitor performance and danmaku distribution.

Key fields include:

• totalDanmakuCount: Total number of danmakus.
• r2lDanmakuCount: Count of Right-to-Left scrolling danmakus.
• l2rDanmakuCount: Count of Left-to-Right scrolling danmakus.
• ftDanmakuCount: Count of Fixed Top danmakus.
• fbDanmakuCount: Count of Fixed Bottom danmakus.
• specialDanmakuCount: Count of special type danmakus.
• cacheHitCount / cacheMissCount: Cache performance metrics.
• isRunningDanmakus: Boolean indicating if danmakus are currently running.

You can update counts using addCount(int type, int count) where type corresponds to BaseDanmaku constants (e.g., BaseDanmaku.TYPE_SCROLL_RL).