Package dev.lukebemish.dynamicassetgenerator.api.client.generators.texsources

Class PaletteCombinedSource

java.lang.Object

dev.lukebemish.dynamicassetgenerator.api.client.generators.texsources.PaletteCombinedSource

All Implemented Interfaces:

TexSource

public final class PaletteCombinedSource
extends Object
implements TexSource

A TexSource that performs a palette transfer, followed by an overlay.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PaletteCombinedSource.Builder
static final record	PaletteCombinedSource.PaletteCombiningOptions

Field Summary

Fields

Modifier and Type	Field	Description
static final com.mojang.serialization.MapCodec<PaletteCombinedSource>	CODEC

Fields inherited from interface dev.lukebemish.dynamicassetgenerator.api.client.generators.TexSource

METADATA_CACHE_KEY

Method Summary

Modifier and Type	Method	Description
@NonNull com.mojang.serialization.MapCodec<? extends TexSource>	codec()
static @NonNull com.mojang.blaze3d.platform.NativeImage	combineImages(com.mojang.blaze3d.platform.NativeImage backgroundImage, com.mojang.blaze3d.platform.NativeImage overlayImage, com.mojang.blaze3d.platform.NativeImage paletteImage, PaletteCombinedSource.PaletteCombiningOptions options)
TexSource	getBackground()
int	getExtendPaletteSize()
TexSource	getOverlay()
TexSource	getPaletted()
@Nullable net.minecraft.server.packs.resources.IoSupplier<com.mojang.blaze3d.platform.NativeImage>	getSupplier(TexSourceDataHolder data, ResourceGenerationContext context)	Provides a supplier for the texture this source will generate, or null if a texture cannot be provided.
boolean	isIncludeBackground()
boolean	isStretchPaletted()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface dev.lukebemish.dynamicassetgenerator.api.client.generators.TexSource

cacheMetadata, getCachedSupplier, persistentCacheData, stringify

Field Details

CODEC

public static final com.mojang.serialization.MapCodec<PaletteCombinedSource> CODEC

Method Details

codec

public @NonNull com.mojang.serialization.MapCodec<? extends TexSource> codec()

Specified by:

codec in interface TexSource

Returns:

a codec which can be used to serialize this source

getSupplier

public @Nullable net.minecraft.server.packs.resources.IoSupplier<com.mojang.blaze3d.platform.NativeImage> getSupplier(TexSourceDataHolder data,
 ResourceGenerationContext context)

Description copied from interface: TexSource

Provides a supplier for the texture this source will generate, or null if a texture cannot be provided. Should be overridden, but not called; call TexSource.getCachedSupplier(dev.lukebemish.dynamicassetgenerator.api.client.generators.TexSourceDataHolder, dev.lukebemish.dynamicassetgenerator.api.ResourceGenerationContext) instead to support caching.

Specified by:

getSupplier in interface TexSource

Parameters:

data - context information passed by outer nesting texture sources; if you depend on this, you will want to implement the caching API (see TexSource.cacheMetadata(com.mojang.serialization.DynamicOps<T>, dev.lukebemish.dynamicassetgenerator.api.client.generators.TexSourceDataHolder))

context - context about the environment the texture is generating in

Returns:

a supplier able to produce the texture, or null if the texture could not be produced.

combineImages

public static @NonNull com.mojang.blaze3d.platform.NativeImage combineImages(com.mojang.blaze3d.platform.NativeImage backgroundImage,
 com.mojang.blaze3d.platform.NativeImage overlayImage,
 com.mojang.blaze3d.platform.NativeImage paletteImage,
 PaletteCombinedSource.PaletteCombiningOptions options)

getOverlay

public TexSource getOverlay()

getBackground

public TexSource getBackground()

getPaletted

public TexSource getPaletted()

isIncludeBackground

public boolean isIncludeBackground()

isStretchPaletted

public boolean isStretchPaletted()

getExtendPaletteSize

public int getExtendPaletteSize()