ra/runelite
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

Merge pull request #2425 from Abextm/async-sprite

Browse Source 
Add SpriteManager to get sprites from the cache
This commit is contained in:
Adam
2018-05-08 17:35:35 -04:00
committed by GitHub
parent e7154cd291 5da9d697da
commit ef10bb5d6c
5 changed files with 174 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
runelite-api/src/main/java/net/runelite/api/Client.java
View File

@@ -108,6 +108,10 @@ public interface Client extends GameEngine
SpritePixels createItemSprite(int itemId, int quantity, int border, int shadowColor, int stackable, boolean noted, int scale);
SpritePixels getSprite(IndexDataBase source, int archiveId, int fileId);
IndexDataBase getIndexSprites();
int getBaseX();
int getBaseY();

29
runelite-api/src/main/java/net/runelite/api/IndexDataBase.java Normal file
View File

@@ -0,0 +1,29 @@
/*
* Copyright (c) 2018 Abex
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package net.runelite.api;
public interface IndexDataBase
{
}

130
runelite-client/src/main/java/net/runelite/client/game/SpriteManager.java Normal file
View File

@@ -0,0 +1,130 @@
/*
* Copyright (c) 2018 Abex
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package net.runelite.client.game;
import com.google.common.cache.Cache;
import com.google.common.cache.CacheBuilder;
import com.google.inject.Inject;
import java.awt.image.BufferedImage;
import java.util.concurrent.TimeUnit;
import java.util.function.Consumer;
import javax.annotation.Nullable;
import javax.inject.Singleton;
import javax.swing.ImageIcon;
import javax.swing.JButton;
import javax.swing.JLabel;
import javax.swing.SwingUtilities;
import net.runelite.api.Client;
import net.runelite.api.GameState;
import net.runelite.api.SpritePixels;
import net.runelite.client.callback.ClientThread;
@Singleton
public class SpriteManager
{
@Inject
private Client client;
@Inject
private ClientThread clientThread;
public Cache<Long, BufferedImage> cache = CacheBuilder.newBuilder()
.maximumSize(128L)
.expireAfterAccess(1, TimeUnit.HOURS)
.build();
@Nullable
public BufferedImage getSprite(int archive, int file)
{
assert client.isClientThread();
if (client.getGameState().ordinal() < GameState.LOGIN_SCREEN.ordinal())
{
return null;
}
Long key = (long) archive << 32 | file;
BufferedImage cached = cache.getIfPresent(key);
if (cached != null)
{
return cached;
}
SpritePixels sp = client.getSprite(client.getIndexSprites(), archive, file);
BufferedImage img = sp.toBufferedImage();
cache.put(key, img);
return img;
}
public void getSpriteAsync(int archive, int file, Consumer<BufferedImage> user)
{
BufferedImage cached = cache.getIfPresent((long) archive << 32 | file);
if (cached != null)
{
user.accept(cached);
return;
}
clientThread.invokeLater(() ->
{
BufferedImage img = getSprite(archive, file);
if (img == null)
{
// Cache isn't loaded yet
return false;
}
user.accept(img);
return true;
});
}
/**
* Calls setIcon on c, ensuring it is repainted when this changes
*/
public void addSpriteTo(JButton c, int archive, int file)
{
getSpriteAsync(archive, file, img ->
{
SwingUtilities.invokeLater(() ->
{
c.setIcon(new ImageIcon(img));
});
});
}
/**
* Calls setIcon on c, ensuring it is repainted when this changes
*/
public void addSpriteTo(JLabel c, int archive, int file)
{
getSpriteAsync(archive, file, img ->
{
SwingUtilities.invokeLater(() ->
{
c.setIcon(new ImageIcon(img));
});
});
}
}

9
runescape-api/src/main/java/net/runelite/rs/api/RSClient.java
View File

@@ -26,6 +26,7 @@ package net.runelite.rs.api;
import java.util.Map;
import net.runelite.api.Client;
import net.runelite.api.IndexDataBase;
import net.runelite.api.SpritePixels;
import net.runelite.api.World;
import net.runelite.api.widgets.Widget;
@@ -305,6 +306,14 @@ public interface RSClient extends RSGameEngine, Client
@Import("createSprite")
RSSpritePixels createItemSprite(int itemId, int quantity, int thickness, int borderColor, int stackable, boolean noted);
@Import("getSpriteAsSpritePixels")
@Override
RSSpritePixels getSprite(IndexDataBase source, int archiveId, int fileId);
@Import("indexSprites")
@Override
RSIndexDataBase getIndexSprites();
@Import("widgetFlags")
@Override
RSHashTable getWidgetFlags();

3
runescape-api/src/main/java/net/runelite/rs/api/RSIndexDataBase.java
View File

@@ -24,9 +24,10 @@
*/
package net.runelite.rs.api;
import net.runelite.api.IndexDataBase;
import net.runelite.mapping.Import;
public interface RSIndexDataBase
public interface RSIndexDataBase extends IndexDataBase
{
@Import("getConfigData")
byte[] getConfigData(int archiveId, int fileId);