Collection of tags associated with this object
StaticcurrentCurrent maximum object count for UID generation
Static ReadonlyInvalidInvalid object UID constant
Gets all color attachments as an array of renderable objects.
Array of color attachment renderables
Gets the render buffer targets for all color attachments.
Array of render buffer target enums for color attachments
Gets the depth attachment if one is set.
The depth attachment renderable or undefined
Gets the depth-stencil attachment if one is set.
The depth-stencil attachment renderable or undefined
Gets the unique identifier for this framebuffer.
The framebuffer's CG API resource handle
Gets the unique object identifier
The object's UID
Gets the stencil attachment if one is set.
The stencil attachment renderable or undefined
Gets the unique name of this object
The unique name string
InternalCopies tag data from another RnObject instance to this object
The source RnObject to copy tags from
Creates and initializes the framebuffer with the specified dimensions.
The width of the framebuffer
The height of the framebuffer
The CG API resource handle for the created framebuffer
Destroys all 3D API resources associated with this framebuffer and its attachments. This includes the framebuffer object itself and all attached render targets. After calling this method, the framebuffer is no longer usable until recreated.
Gets the render target texture attached to the specified color attachment index.
The color attachment index
The render target texture or undefined if not found or not a render target texture
Gets the render target texture attached as the depth attachment.
The depth render target texture or undefined if not found or not a render target texture
Retrieves a complete tag object (name and value) for the specified tag name
The name of the tag to retrieve
A Tag object containing the name and value
Retrieves the value associated with a specific tag name
The name of the tag whose value to retrieve
The tag value, or undefined if the tag doesn't exist
Checks whether this object has a tag with the specified name
The name of the tag to check for
True if the tag exists (value is not null/undefined), false otherwise
Checks if this object has a tag with the specified name and value
The tag name to match
The tag value to match
True if the object has a matching tag, false otherwise
Checks if this object has all the specified tags with exactly matching values
Object containing tag names as keys and expected values
True if all specified tags exist with matching values, false otherwise
Checks if the object's combined tag string contains all the provided search strings. This allows for flexible searching within tag names and values.
Array of strings that must all be present in the combined tag string
True if all strings are found in the combined tag string, false otherwise
Removes a tag from this object
The name of the tag to remove
Resizes the framebuffer and all its attachments to the specified dimensions. This method destroys the current framebuffer and recreates it with new dimensions.
The new width
The new height
Sets a color attachment at the specified index.
The color attachment index
The renderable object to attach
True if the attachment was successful, false if dimensions don't match
Sets a color attachment for a specific face of a cube texture.
The color attachment index
The cube face index (0-5)
The mip level to attach
The cube texture renderable to attach
True if the attachment was successful, false if dimensions don't match
Sets a color attachment layer at the specified index for array textures.
The color attachment index
The renderable object to attach
The layer index within the array texture
The mip level to attach
True if the attachment was successful, false if dimensions don't match
Sets the depth attachment for this framebuffer.
The renderable object to use as depth attachment
True if the attachment was successful, false if dimensions don't match
Sets the combined depth-stencil attachment for this framebuffer.
The renderable object to use as depth-stencil attachment
True if the attachment was successful, false if dimensions don't match
Sets the stencil attachment for this framebuffer.
The renderable object to use as stencil attachment
True if the attachment was successful, false if dimensions don't match
Attempts to set a tag on this object. If the tag already exists, it will be replaced.
The tag object containing the name and value to set
True if the tag was successfully set, false if the tag name contains invalid characters
Attempts to set a unique name for this object
The desired unique name
If true, appends UID to make name unique when conflicts occur; if false, fails on conflict
True if the name was successfully set, false if there was a conflict and toAddNameIfConflict was false
Unregisters this object from all tracking collections. Should be called when the object is being destroyed.
Validates that a tag string contains only allowed characters (alphanumeric and underscore)
The string to validate
True if the string contains only valid characters, false if it contains invalid characters
Finds the index of the specified renderable in the color attachments array.
The renderable object to search for
The index of the renderable in color attachments, or -1 if not found
Static_InternalResets all static object tracking data. Used primarily for testing.
StaticgetRetrieves an RnObject instance by its unique identifier
The unique identifier of the object to retrieve
The RnObject instance or undefined if not found or garbage collected
StaticgetRetrieves an RnObject instance by its unique name
The unique name of the object to retrieve
The RnObject instance or undefined if not found or garbage collected
StaticsearchSearches for the first object that has a specific tag with the given value
The tag name to search for
The tag value to match
WeakRef to the first matching object, or undefined if not found
FrameBuffer class represents a framebuffer object that manages render targets for off-screen rendering operations. It handles color, depth, and stencil attachments and provides methods to configure and manage the framebuffer state.