API: Renderer

» Overview

Assetify provides a comprehensive suite of APIs designed to enhance the visual fidelity and performance of assets. This module includes a custom rendering pipeline that optimizes the rendering process, allowing developers to achieve high-quality graphics with efficient resource management.

Features such as dynamic sky rendering enable immersive environmental experiences, adapting seamlessly to changes in lighting and atmospheric conditions. Overall, the renderer module empowers creators with the tools needed to build visually stunning systems, ensuring robust and flexible asset management capabilities within the Assetify framework.

» Importing

Add the below code globally once in either of the shared .lua script of the resource you want to use within:

loadstring(exports.assetify_library:import("renderer"))()

» APIs

• assetify.renderer.isRendering() - client

  ✨ Retrieves renderer's state.

  local bool: result = assetify.renderer.isRendering()

• assetify.renderer.setRendering() - client

  ✨ Sets renderer's state.

  local bool: result = assetify.renderer.setRendering(
     bool: state,
     table: modes
  )

• assetify.renderer.getVirtualSource() - client

  ✨ Fetches virtual source.

  local element: cSource = assetify.renderer.getVirtualSource()

• assetify.renderer.getVirtualRTs() - client

  ✨ Fetches virtual RTs.

  local table: cVRTs = assetify.renderer.getVirtualRTs()

• assetify.renderer.isEmissiveMode() - client

  ✨ Retrieves emissive mode's state.

  local bool: result = assetify.renderer.isEmissiveMode()

• assetify.renderer.setEmissiveMode() - client

  ✨ *Sets emissive mode's state.

  local bool: result = assetify.renderer.setEmissiveMode(
     bool: state
  )

• assetify.renderer.isDynamicSky() - client

  ✨ Retrieves dynamic sky's state.

  local bool: result = assetify.renderer.isDynamicSky()

• assetify.renderer.setDynamicSky() - client

  ✨ Sets dynamic sky's state.

  local bool: result = assetify.renderer.setDynamicSky(
     bool: state
  )

• assetify.renderer.getDynamicStarIntensity() - client

  ✨ Retrieves dynamic star's intensity.

  local bool: result = assetify.renderer.getDynamicStarIntensity()

• assetify.renderer.setDynamicStarIntensity() - client

  ✨ Sets dynamic star's intensity.

  local bool: result = assetify.renderer.setDynamicStarIntensity(
     float: intensity
  )

• assetify.renderer.getDynamicSunColor() - client

  ✨ Retrieves dynamic sun's color.

  local float: r, float: g, float: b = assetify.renderer.getDynamicSunColor()

• assetify.renderer.setDynamicSunColor() - client

  ✨ Sets dynamic sun's color.

  local bool: result = assetify.renderer.setDynamicSunColor(
     float: r,
     float: g,
     float: b
  )

• assetify.renderer.getDynamicCloudDensity() - client

  ✨ Retrieves dynamic cloud's density.

  local float: result = assetify.renderer.getDynamicCloudDensity()

• assetify.renderer.setDynamicCloudDensity() - client

  ✨ Sets dynamic cloud's density.

  local bool: result = assetify.renderer.setDynamicCloudDensity(
     float: density
  )

• assetify.renderer.getDynamicCloudScale() - client

  ✨ Retrieves dynamic cloud's scale.

  local float: result = assetify.renderer.getDynamicCloudScale()

• assetify.renderer.setDynamicCloudScale() - client

  ✨ Sets dynamic cloud's scale.

  local bool: result = assetify.renderer.setDynamicCloudScale(
     float: scale
  )

• assetify.renderer.getDynamicCloudColor() - client

  ✨ Retrieves dynamic cloud's color.

  local float: r, float: g, float: b = assetify.renderer.getDynamicCloudColor()

• assetify.renderer.setDynamicCloudColor() - client

  ✨ Sets dynamic cloud's color.

  local bool: result = assetify.renderer.setDynamicCloudColor(
     float: r,
     float: g,
     float: b
  )

• assetify.renderer.getTimeCycle() - client

  ✨ Retrieves dynamic sky's timecycle.

  local table: timecycle = assetify.renderer.getTimeCycle()

• assetify.renderer.setTimeCycle() - client

  ✨ Sets dynamic sky's timecycle.
  🚨 Refer timecycle.rw to know more about timecycle format!

  local bool: result = assetify.renderer.setTimeCycle(
     table: timecycle
  )