Package foundry.veil.api.resource.type

Record Class FramebufferResource

java.lang.Object

java.lang.Record

foundry.veil.api.resource.type.FramebufferResource

All Implemented Interfaces:

VeilTextResource<FramebufferResource>, VeilResource<FramebufferResource>

public record FramebufferResource(VeilResourceInfo resourceInfo)
extends Record
implements VeilTextResource<FramebufferResource>

Constructor Summary

Constructors

Constructor	Description
FramebufferResource(VeilResourceInfo resourceInfo)	Creates an instance of a FramebufferResource record class.

Method Summary

Modifier and Type	Method	Description
boolean	canHotReload()
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
List<VeilResourceAction<FramebufferResource>>	getActions()
int	getIconCode()	Gets the icon code for this resource (ex.
final int	hashCode()	Returns a hash code value for this object.
void	hotReload()	Hot-reloads the resource
@Nullable imgui.extension.texteditor.TextEditorLanguageDefinition	languageDefinition()
VeilResourceInfo	resourceInfo()	Returns the value of the resourceInfo record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface foundry.veil.api.resource.VeilResource

copyToResources, onFileSystemChange, render

Constructor Details

FramebufferResource

public FramebufferResource(VeilResourceInfo resourceInfo)

Creates an instance of a FramebufferResource record class.

Parameters:

resourceInfo - the value for the resourceInfo record component

Method Details

getActions

public List<VeilResourceAction<FramebufferResource>> getActions()

Specified by:

getActions in interface VeilResource<FramebufferResource>

Returns:

All actions that can be performed on this resource

canHotReload

public boolean canHotReload()

Specified by:

canHotReload in interface VeilResource<FramebufferResource>

Returns:

If this resource can be hot-reloaded

hotReload

public void hotReload()

Description copied from interface: VeilResource

Hot-reloads the resource

Specified by:

hotReload in interface VeilResource<FramebufferResource>

getIconCode

public int getIconCode()

Description copied from interface: VeilResource

Gets the icon code for this resource (ex. 0xED0F)

Specified by:

getIconCode in interface VeilResource<FramebufferResource>

languageDefinition

@Nullable
public @Nullable imgui.extension.texteditor.TextEditorLanguageDefinition languageDefinition()

Specified by:

languageDefinition in interface VeilTextResource<FramebufferResource>

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

resourceInfo

public VeilResourceInfo resourceInfo()

Returns the value of the resourceInfo record component.

Specified by:

resourceInfo in interface VeilResource<FramebufferResource>

Returns:

the value of the resourceInfo record component