Interface SpriteContentsConstructor

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface SpriteContentsConstructor

Functional interface representing the signature of the SpriteContents constructor but nullable to support skipping based on metadata.

Method Summary

Modifier and Type	Method	Description
@Nullable SpriteContents	create(Identifier id, FrameSize frameSize, NativeImage nativeImage, Optional<AnimationMetadataSection> animationMetadata, List<MetadataSectionType.WithValue<?>> additionalMetadata, Optional<TextureMetadataSection> textureMetadata)	Construct an instance of SpriteContents or return null to not load the sprite.

Method Details

create

@Nullable SpriteContents create(Identifier id,
 FrameSize frameSize,
 NativeImage nativeImage,
 Optional<AnimationMetadataSection> animationMetadata,
 List<MetadataSectionType.WithValue<?>> additionalMetadata,
 Optional<TextureMetadataSection> textureMetadata)

Construct an instance of SpriteContents or return null to not load the sprite.

Parameters:

id - the id of the sprite

frameSize - the frame size of the sprite

nativeImage - the image of the sprite

animationMetadata - the sprite's animation metadata

additionalMetadata - additional metadata loaded from the resource

textureMetadata - texture metadata (i.e. mip map strategy)

Returns:

an instance of SpriteContents or return null to not load the sprite