Creates a new MeshRendererComponent instance.
The unique identifier of the entity this component belongs to
The component's system identifier
The repository managing entities
Whether this component is being reused from a pool
Protected
__currentProtected
__entitythe instance of EntityRepository
Protected
__entitythe entity unique Id which this component belongs to
Protected
__memorythe instance of MemoryManager
Collection of tags associated with this object
Static
Readonly
InvalidInvalid object UID constant
Static
__shaderStatic
_isStatic
Readonly
_processStatic
currentCurrent maximum object count for UID generation
Static
isGets the Scoped ID of this Component instance. The SID is unique within the component type and represents the instance index.
The component scoped ID
Gets the component type ID for this instance.
The component type ID
Gets the current process stage of the component. This determines which update methods are currently being called.
The current process stage
Gets the diffuse cube map used for IBL lighting.
The diffuse cube map texture or undefined if not set
Gets the contribution factor for the diffuse cube map in IBL calculations.
The diffuse cube map contribution factor (0.0 to 1.0)
Sets the contribution factor for the diffuse cube map in IBL calculations.
The contribution factor (0.0 to 1.0)
Gets the unique ID of the entity that owns this component.
The entity unique ID
Gets the maximum number of components of this type that can exist.
The maximum number of components
Gets the unique object identifier
The object's UID
Gets the rotation angle of the cube map in radians.
The rotation angle in radians
Sets the rotation angle of the cube map in radians.
The rotation angle in radians
Gets the sheen cube map used for IBL lighting.
The sheen cube map texture or undefined if not set
Gets the specular cube map used for IBL lighting.
The specular cube map texture or undefined if not set
Gets the contribution factor for the specular cube map in IBL calculations.
The specular cube map contribution factor (0.0 to 1.0)
Sets the contribution factor for the specular cube map in IBL calculations.
The contribution factor (0.0 to 1.0)
Gets the unique name of this object
The unique name string
Gets the update count for this component instance.
The current update count
Static
componentTIDGets the component type ID for MeshRendererComponent.
The component type ID
Static
updateGets the global update count for all MeshRendererComponent instances.
The global update count
Instance-specific render method for this mesh renderer component. Currently empty as rendering is handled by the static common_$render method.
Internal
Copies tag data from another RnObject instance to this object
The source RnObject to copy tags from
Performs a shallow copy of properties from another MeshRendererComponent. Copies cube map settings and contributions without deep cloning the textures.
The source component to copy from
Adds the MeshRenderer component functionality to an entity class. This method extends the entity base class with mesh renderer specific methods.
The target entity base class
The component class to add (unused parameter for type safety)
The enhanced entity class with mesh renderer methods
Gets detailed byte information about a specific member field of this component. This includes offsets, lengths, and location information for GPU access.
The name of the member field
Detailed byte information object
Checks whether the specified ProcessStage method exists in this Component instance. This is used to determine if this component can handle a particular process stage.
The process stage to check for
True if the method exists, 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
Transitions the component to a different process stage. This affects which update methods will be called during the frame processing.
The target stage to move to
Registers a dependency relationship with another component. This method is intended for future use in managing component dependencies.
The component to depend on
Whether this dependency is required
Registers a member field of the component class for memory allocation. This method defines the memory layout and characteristics of component data members.
The intended purpose/type of buffer use
The name of the member field
The class type of the data
The primitive data type (e.g., Float32, Int32)
Initial values for the member field
Sets the IBL (Image-Based Lighting) cube maps for this mesh renderer.
The diffuse cube map texture for IBL
The specular cube map texture for IBL
Optional
sheenCubeTexture: RenderTargetTextureCube | CubeTextureOptional sheen cube map texture for IBL
Allocates memory for all member fields of this component instance. This method is called during component initialization to set up memory layout and allocate space for the specified number of entities.
The number of entities to allocate memory for
Whether to reuse existing memory allocations
Allocates memory for a specific member field of this component instance. This method takes one memory slot from the shared memory pool for the specified member.
The name of the member field
The data class type for the member
Initial values to set for the member
Whether to reuse an existing memory slot
The component scoped ID
null on success
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
Static
_resetStatic
common_Common loading method that initializes the rendering strategy based on the process approach. This method sets up either WebGPU or WebGL rendering strategies.
The graphics API approach to use (WebGPU or WebGL)
Static
common_Static
common_Common rendering method that executes the actual rendering of primitives. Delegates to the appropriate rendering strategy (WebGL or WebGPU).
True if rendering was successful, false otherwise
Static
doesChecks whether the specified ProcessStage method exists in the given Component class. This is used to determine if a component can handle a particular process stage.
The component class to check
The process stage to check for
True if the method exists, false otherwise
Static
getGets the memory accessor for a specific member field of a component class. The accessor provides access to the underlying typed array data.
The name of the member field
The component class
The accessor for the member field
Static
getGets the total byte length of all member fields for a specific buffer use type in the given component class.
The buffer use type
The component class
The total byte length of members
Static
getGets the byte offset of the first element of a specific member field within the buffer.
The name of the member field
The component class
The byte offset in the buffer
Static
getGets the byte offset of the first element of a specific member field within the buffer view.
The name of the member field
The component class
The byte offset in the buffer view
Static
getGets the byte offset of the component type's data within the buffer.
The buffer use type
The component class
The byte offset in the buffer
Static
getGets the ComponentType of a specific member field in a component class. This is useful for understanding the primitive data type of component members.
The name of the member field
The component class to query
The ComponentType of the member or undefined if not found
Static
getGets the CompositionType of a specific member field in a component class. This is useful for understanding the data structure of component members.
The name of the member field
The component class to query
The CompositionType of the member or undefined if not found
Static
getGets detailed byte information about a member field by Component SID. This is a static version that looks up the component by its scoped ID.
The component class type
The scoped ID of the component
The name of the member field
Detailed byte information object or undefined if component not found
Static
getGets detailed byte information about a specific member field of a component. This includes offsets, lengths, and location information for GPU access.
The component instance to analyze
The name of the member field
Detailed byte information object
Static
getGets the pixel location offset in the buffer for a specific member of a component type. This is useful for GPU texture-based data access where locations are measured in pixels.
The component class type
The name of the member field
The pixel location offset in the buffer
Static
getStatic
getStatic
processProcesses all components of a given type for a specific process stage. This method iterates through all components of the specified type and calls their corresponding process stage method if they are in that stage.
The component class to process
The process stage to execute
Static
searchSearches 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
Static
sort_Sorts and filters mesh components for rendering based on camera frustum and material properties. Performs frustum culling and sorts primitives by render order and depth.
The render pass containing mesh components and rendering context
Array of primitive UIDs sorted for optimal rendering
Static
takeCreates and configures a memory accessor for a specific member field. This method allocates buffer memory and creates an accessor for efficient data access.
The intended use of the buffer
The name of the member field
The component class
The composition type (e.g., Vec3, Mat4)
The component data type (e.g., Float32, Int32)
The number of components to allocate for
Result containing the accessor or an error
Static
updateUpdates components specifically for the render stage with render pass context. This method calls the sort_$render method of the component class to handle render-specific processing and sorting.
The component class to update
The render process stage
The current render pass context
The result of the sort_$render method
MeshRendererComponent is a component that manages the rendering of a mesh entity. It handles mesh rendering pipeline, IBL (Image-Based Lighting) cube maps, frustum culling, and rendering optimization through various strategies.