mirror of
https://github.com/scp-fs2open/fs2open.github.com.git
synced 2026-11-09 04:49:39 -10:00
asarium
99f69c903e
This allows to render screen space decals into the deferred lighting buffers no matter how complex the underlying geometry is. Currently there is only limited support for using this in the engine. Only weapon impact decals are supported at the moment for testing purposes.
88 lines
2.5 KiB
C++
88 lines
2.5 KiB
C++
#pragma once
|
|
|
|
#include "globalincs/pstypes.h"
|
|
|
|
#include "object/object.h"
|
|
|
|
#include "utils/RandomRange.h"
|
|
|
|
namespace decals {
|
|
|
|
/**
|
|
* @brief A reference to a decal definition
|
|
*/
|
|
typedef int DecalReference;
|
|
|
|
/**
|
|
* @brief A structure containing all information for creating a decal
|
|
*/
|
|
struct creation_info {
|
|
DecalReference definition_handle = -1;
|
|
float radius = -1.0f;
|
|
util::UniformFloatRange lifetime = ::util::UniformFloatRange(-1.0f);
|
|
};
|
|
|
|
/**
|
|
* @brief Initializes the global state of the decal system. Call once at game init.
|
|
*/
|
|
void initialize();
|
|
|
|
|
|
/**
|
|
* @brief Parses the information for a decal reference
|
|
*
|
|
* @details This function expects that the initial token has already been consumed by the parse system.
|
|
*
|
|
* @param dest_info The creation information struct to parse the information into
|
|
* @param is_new_entry Set to @c false if the currently parsed object used +nocreate
|
|
*/
|
|
void parseDecalReference(creation_info& dest_info, bool is_new_entry = true);
|
|
|
|
/**
|
|
* @brief Loads the bitmaps specified by the creation info into texture memory
|
|
*
|
|
* This should be called when the bitmaps of the object using this decal are loaded.
|
|
*
|
|
* @param info The creation information containing the decal definition handle
|
|
*/
|
|
void loadBitmaps(const creation_info& info);
|
|
|
|
/**
|
|
* @brief Page in the bitmap data of the specified creation information. Needs to be called after loadBitmaps
|
|
* @param info The information to page in
|
|
*/
|
|
void pageInDecal(const creation_info& info);
|
|
|
|
/**
|
|
* @brief Shut down the decal system. Must be called from game_shutdown
|
|
*/
|
|
void shutdown();
|
|
|
|
/**
|
|
* @brief Initialize the decal system for the mission. Must be called before every mission is started
|
|
*/
|
|
void initializeMission();
|
|
|
|
/**
|
|
* @brief Renders all currently active decals and removes invalid decals from the active list.
|
|
*/
|
|
void renderAll();
|
|
|
|
/**
|
|
* @brief Creates a new decal on the specified object at the specified location
|
|
*
|
|
* @param info The decal to create
|
|
* @param host The object host on which to create this decal. Must be a ship.
|
|
* @param submodel The submodel of the object model on which to create the decal.
|
|
* @param local_pos The position in the frame of reference of the submodel at which the decal should be created.
|
|
* @param local_orient The orientation of the decal in the frame of reference of the submodel. The forward vector of the
|
|
* orientation should look along the direction
|
|
*/
|
|
void addDecal(creation_info& info,
|
|
object* host,
|
|
int submodel,
|
|
const vec3d& local_pos,
|
|
const matrix& local_orient);
|
|
|
|
}
|