![]() |
ReShade
A generic post-processing injector for games and video software.
|
A ReShade effect runtime, used to control effects. More...
#include <reshade_api.hpp>
Public Member Functions | |
virtual command_queue * | get_command_queue ()=0 |
Gets the main graphics command queue associated with this effect runtime. This may potentially be different from the presentation queue and should be used to execute graphics commands on. More... | |
virtual void | render_effects (command_list *cmd_list, resource_view rtv, resource_view rtv_srgb={ 0 })=0 |
Applies post-processing effects to the specified render targets and prevents the usual rendering of effects before swap chain presentation of the current frame. This can be used to force ReShade to render effects at a certain point during the frame to e.g. avoid effects being applied to user interface elements of the application. More... | |
virtual bool | capture_screenshot (uint8_t *pixels)=0 |
Captures a screenshot of the current back buffer resource and returns its image data in 32 bits-per-pixel RGBA format. More... | |
virtual void | get_screenshot_width_and_height (uint32_t *out_width, uint32_t *out_height) const =0 |
Gets the current buffer dimensions of the swap chain as used with effect rendering. The returned values are equivalent to BUFFER_WIDTH and BUFFER_HEIGHT in ReShade FX. More... | |
virtual bool | is_key_down (uint32_t keycode) const =0 |
Gets the current status of the specified key. More... | |
virtual bool | is_key_pressed (uint32_t keycode) const =0 |
Gets whether the specified key was pressed this frame. More... | |
virtual bool | is_key_released (uint32_t keycode) const =0 |
Gets whether the specified key was released this frame. More... | |
virtual bool | is_mouse_button_down (uint32_t button) const =0 |
Gets the current status of the specified mouse button. More... | |
virtual bool | is_mouse_button_pressed (uint32_t button) const =0 |
Gets whether the specified mouse button was pressed this frame. More... | |
virtual bool | is_mouse_button_released (uint32_t button) const =0 |
Gets whether the specified mouse button was released this frame. More... | |
virtual void | get_mouse_cursor_position (uint32_t *out_x, uint32_t *out_y, int16_t *out_wheel_delta=nullptr) const =0 |
Gets the current absolute position of the mouse cursor in screen coordinates. More... | |
virtual void | enumerate_uniform_variables (const char *effect_name, void(*callback)(effect_runtime *runtime, effect_uniform_variable variable, void *user_data), void *user_data)=0 |
Enumerates all uniform variables of loaded effects and calls the specified callback function with a handle for each one. More... | |
template<typename F > | |
void | enumerate_uniform_variables (const char *effect_name, F lambda) |
Enumerates all uniform variables of loaded effects and calls the specified callback function with a handle for each one. More... | |
virtual effect_uniform_variable | find_uniform_variable (const char *effect_name, const char *variable_name) const =0 |
Finds a specific uniform variable in the loaded effects and returns a handle to it. More... | |
virtual void | get_uniform_variable_type (effect_uniform_variable variable, format *out_base_type, uint32_t *out_rows=nullptr, uint32_t *out_columns=nullptr, uint32_t *out_array_length=nullptr) const =0 |
Gets information about the data type of a uniform variable . More... | |
virtual void | get_uniform_variable_name (effect_uniform_variable variable, char *name, size_t *length) const =0 |
Gets the name of a uniform variable . More... | |
template<size_t SIZE> | |
void | get_uniform_variable_name (effect_uniform_variable variable, char(&name)[SIZE]) const |
virtual bool | get_annotation_bool_from_uniform_variable (effect_uniform_variable variable, const char *name, bool *values, size_t count, size_t array_index=0) const =0 |
Gets the value from an annotation attached to the specified uniform variable as boolean values. More... | |
virtual bool | get_annotation_float_from_uniform_variable (effect_uniform_variable variable, const char *name, float *values, size_t count, size_t array_index=0) const =0 |
Gets the value from an annotation attached to the specified uniform variable as floating-point values. More... | |
virtual bool | get_annotation_int_from_uniform_variable (effect_uniform_variable variable, const char *name, int32_t *values, size_t count, size_t array_index=0) const =0 |
Gets the value from an annotation attached to the specified uniform variable as signed integer values. More... | |
virtual bool | get_annotation_uint_from_uniform_variable (effect_uniform_variable variable, const char *name, uint32_t *values, size_t count, size_t array_index=0) const =0 |
Gets the value from an annotation attached to the specified uniform variable as unsigned integer values. More... | |
virtual bool | get_annotation_string_from_uniform_variable (effect_uniform_variable variable, const char *name, char *value, size_t *length) const =0 |
Gets the value from a string annotation attached to the specified uniform variable . More... | |
template<size_t SIZE> | |
bool | get_annotation_string_from_uniform_variable (effect_uniform_variable variable, const char *name, char(&value)[SIZE]) const |
virtual void | get_uniform_value_bool (effect_uniform_variable variable, bool *values, size_t count, size_t array_index=0) const =0 |
Gets the value of the specified uniform variable as boolean values. More... | |
virtual void | get_uniform_value_float (effect_uniform_variable variable, float *values, size_t count, size_t array_index=0) const =0 |
Gets the value of the specified uniform variable as floating-point values. More... | |
virtual void | get_uniform_value_int (effect_uniform_variable variable, int32_t *values, size_t count, size_t array_index=0) const =0 |
Gets the value of the specified uniform variable as signed integer values. More... | |
virtual void | get_uniform_value_uint (effect_uniform_variable variable, uint32_t *values, size_t count, size_t array_index=0) const =0 |
Gets the value of the specified uniform variable as unsigned integer values. More... | |
virtual void | set_uniform_value_bool (effect_uniform_variable variable, const bool *values, size_t count, size_t array_index=0)=0 |
Sets the value of the specified uniform variable as boolean values. More... | |
void | set_uniform_value_bool (effect_uniform_variable variable, bool x, bool y=bool(0), bool z=bool(0), bool w=bool(0)) |
Sets the value of the specified uniform variable as a vector of boolean values. More... | |
virtual void | set_uniform_value_float (effect_uniform_variable variable, const float *values, size_t count, size_t array_index=0)=0 |
Sets the value of the specified uniform variable as floating-point values. More... | |
void | set_uniform_value_float (effect_uniform_variable variable, float x, float y=float(0), float z=float(0), float w=float(0)) |
Sets the value of the specified uniform variable as a vector of floating-point values. More... | |
virtual void | set_uniform_value_int (effect_uniform_variable variable, const int32_t *values, size_t count, size_t array_index=0)=0 |
Sets the value of the specified uniform variable as signed integer values. More... | |
void | set_uniform_value_int (effect_uniform_variable variable, int32_t x, int32_t y=int32_t(0), int32_t z=int32_t(0), int32_t w=int32_t(0)) |
Sets the value of the specified uniform variable as a vector of signed integer values. More... | |
virtual void | set_uniform_value_uint (effect_uniform_variable variable, const uint32_t *values, size_t count, size_t array_index=0)=0 |
Sets the value of the specified uniform variable as unsigned integer values. More... | |
void | set_uniform_value_uint (effect_uniform_variable variable, uint32_t x, uint32_t y=uint32_t(0), uint32_t z=uint32_t(0), uint32_t w=uint32_t(0)) |
Sets the value of the specified uniform variable as a vector of unsigned integer values. More... | |
virtual void | enumerate_texture_variables (const char *effect_name, void(*callback)(effect_runtime *runtime, effect_texture_variable variable, void *user_data), void *user_data)=0 |
Enumerates all texture variables of loaded effects and calls the specified callback function with a handle for each one. More... | |
template<typename F > | |
void | enumerate_texture_variables (const char *effect_name, F lambda) |
Enumerates all texture variables of loaded effects and calls the specified callback function with a handle for each one. More... | |
virtual effect_texture_variable | find_texture_variable (const char *effect_name, const char *variable_name) const =0 |
Finds a specific texture variable in the loaded effects and returns a handle to it. More... | |
virtual void | get_texture_variable_name (effect_texture_variable variable, char *name, size_t *length) const =0 |
Gets the name of a texture variable . More... | |
template<size_t SIZE> | |
void | get_texture_variable_name (effect_texture_variable variable, char(&name)[SIZE]) const |
virtual bool | get_annotation_bool_from_texture_variable (effect_texture_variable variable, const char *name, bool *values, size_t count, size_t array_index=0) const =0 |
Gets the value from an annotation attached to the specified texture variable as boolean values. More... | |
virtual bool | get_annotation_float_from_texture_variable (effect_texture_variable variable, const char *name, float *values, size_t count, size_t array_index=0) const =0 |
Gets the value from an annotation attached to the specified texture variable as floating-point values. More... | |
virtual bool | get_annotation_int_from_texture_variable (effect_texture_variable variable, const char *name, int32_t *values, size_t count, size_t array_index=0) const =0 |
Gets the value from an annotation attached to the specified texture variable as signed integer values. More... | |
virtual bool | get_annotation_uint_from_texture_variable (effect_texture_variable variable, const char *name, uint32_t *values, size_t count, size_t array_index=0) const =0 |
Gets the value from an annotation attached to the specified texture variable as unsigned integer values. More... | |
virtual bool | get_annotation_string_from_texture_variable (effect_texture_variable variable, const char *name, char *value, size_t *length) const =0 |
Gets the value from a string annotation attached to the specified texture variable . More... | |
template<size_t SIZE> | |
bool | get_annotation_string_from_texture_variable (effect_texture_variable variable, const char *name, char(&value)[SIZE]) const |
virtual void | update_texture (effect_texture_variable variable, const uint32_t width, const uint32_t height, const uint8_t *pixels)=0 |
Uploads 32 bits-per-pixel RGBA image data to the specified texture variable . More... | |
virtual void | get_texture_binding (effect_texture_variable variable, resource_view *out_srv, resource_view *out_srv_srgb=nullptr) const =0 |
Gets the shader resource view that is bound to the specified texture variable . More... | |
virtual void | update_texture_bindings (const char *semantic, resource_view srv, resource_view srv_srgb={ 0 })=0 |
Binds a new shader resource view to all texture variables that use the specified semantic . More... | |
virtual void | enumerate_techniques (const char *effect_name, void(*callback)(effect_runtime *runtime, effect_technique technique, void *user_data), void *user_data)=0 |
Enumerates all techniques of loaded effects and calls the specified callback function with a handle for each one. More... | |
template<typename F > | |
void | enumerate_techniques (const char *effect_name, F lambda) |
Enumerates all techniques of loaded effects and calls the specified callback function with a handle for each one. More... | |
virtual effect_technique | find_technique (const char *effect_name, const char *technique_name)=0 |
Finds a specific technique in the loaded effects and returns a handle to it. More... | |
virtual void | get_technique_name (effect_technique technique, char *name, size_t *length) const =0 |
Gets the name of a technique . More... | |
template<size_t SIZE> | |
void | get_technique_name (effect_technique technique, char(&name)[SIZE]) const |
virtual bool | get_annotation_bool_from_technique (effect_technique technique, const char *name, bool *values, size_t count, size_t array_index=0) const =0 |
Gets the value from an annotation attached to the specified technique as boolean values. More... | |
virtual bool | get_annotation_float_from_technique (effect_technique technique, const char *name, float *values, size_t count, size_t array_index=0) const =0 |
Gets the value from an annotation attached to the specified technique as floating-point values. More... | |
virtual bool | get_annotation_int_from_technique (effect_technique technique, const char *name, int32_t *values, size_t count, size_t array_index=0) const =0 |
Gets the value from an annotation attached to the specified technique as signed integer values. More... | |
virtual bool | get_annotation_uint_from_technique (effect_technique technique, const char *name, uint32_t *values, size_t count, size_t array_index=0) const =0 |
Gets the value from an annotation attached to the specified technique as unsigned integer values. More... | |
virtual bool | get_annotation_string_from_technique (effect_technique technique, const char *name, char *value, size_t *length) const =0 |
Gets the value from a string annotation attached to the specified technique . More... | |
template<size_t SIZE> | |
bool | get_annotation_string_from_technique (effect_technique technique, const char *name, char(&value)[SIZE]) const |
virtual bool | get_technique_state (effect_technique technique) const =0 |
Gets the state of a technique . More... | |
virtual void | set_technique_state (effect_technique technique, bool enabled)=0 |
Enables or disable the specified technique . More... | |
virtual bool | get_preprocessor_definition (const char *name, char *value, size_t *length) const =0 |
Gets the value of global preprocessor definition. More... | |
template<size_t SIZE> | |
bool | get_preprocessor_definition (const char *name, char(&value)[SIZE]) const |
virtual void | set_preprocessor_definition (const char *name, const char *value)=0 |
Defines a global preprocessor definition to the specified value . More... | |
virtual void | render_technique (effect_technique technique, command_list *cmd_list, resource_view rtv, resource_view rtv_srgb={ 0 })=0 |
Applies a technique to the specified render targets (regardless of the state of this technique). More... | |
![]() | |
virtual void * | get_hwnd () const =0 |
Gets the window handle of the window this swap chain was created with, or nullptr if this is an offscreen swap chain. More... | |
virtual resource | get_back_buffer (uint32_t index)=0 |
Gets the back buffer resource at the specified index in this swap chain. More... | |
virtual uint32_t | get_back_buffer_count () const =0 |
Gets the number of back buffer resources in this swap chain. More... | |
resource | get_current_back_buffer () |
Gets the current back buffer resource. More... | |
virtual uint32_t | get_current_back_buffer_index () const =0 |
Gets the index of the back buffer resource that can currently be rendered into. More... | |
![]() | |
virtual device * | get_device ()=0 |
Gets the parent device for this object. More... | |
![]() | |
virtual uint64_t | get_native () const =0 |
Gets the underlying native object for this API object. More... | |
virtual void | get_private_data (const uint8_t guid[16], uint64_t *data) const =0 |
Gets a user-defined 64-bit value from the object that was previously set via set_private_data, or zero if none associated with the specified guid exists. More... | |
virtual void | set_private_data (const uint8_t guid[16], const uint64_t data)=0 |
Stores a user-defined 64-bit value in the object and associates it with the specified guid . More... | |
template<typename T > | |
T & | get_private_data () const |
Gets a reference to user-defined data from the object that was previously allocated via create_private_data. More... | |
template<typename T > | |
T & | create_private_data () |
Allocates user-defined data and stores it in the object. More... | |
template<typename T > | |
void | destroy_private_data () |
Frees user-defined data that was previously allocated via create_private_data. More... | |
A ReShade effect runtime, used to control effects.
A separate runtime is instantiated for every swap chain.
|
pure virtual |
Captures a screenshot of the current back buffer resource and returns its image data in 32 bits-per-pixel RGBA format.
pixels | Pointer to an array of width * height * 4 bytes the image data is written to. |
|
inline |
Enumerates all techniques of loaded effects and calls the specified callback function with a handle for each one.
effect_name | File name of the effect file to enumerate techniques from, or nullptr to enumerate those of all loaded effects. |
lambda | Function to call for every technique. |
|
pure virtual |
Enumerates all techniques of loaded effects and calls the specified callback function with a handle for each one.
effect_name | File name of the effect file to enumerate techniques from, or nullptr to enumerate those of all loaded effects. |
callback | Function to call for every technique. |
user_data | Optional pointer passed to the callback function. |
|
inline |
Enumerates all texture variables of loaded effects and calls the specified callback function with a handle for each one.
effect_name | File name of the effect file to enumerate texture variables from, or nullptr to enumerate those of all loaded effects. |
lambda | Function to call for every texture variable. |
|
pure virtual |
Enumerates all texture variables of loaded effects and calls the specified callback function with a handle for each one.
effect_name | File name of the effect file to enumerate texture variables from, or nullptr to enumerate those of all loaded effects. |
callback | Function to call for every texture variable. |
user_data | Optional pointer passed to the callback function. |
|
inline |
Enumerates all uniform variables of loaded effects and calls the specified callback function with a handle for each one.
effect_name | File name of the effect file to enumerate uniform variables from, or nullptr to enumerate those of all loaded effects. |
lambda | Function to call for every uniform variable. |
|
pure virtual |
Enumerates all uniform variables of loaded effects and calls the specified callback function with a handle for each one.
effect_name | File name of the effect file to enumerate uniform variables from, or nullptr to enumerate those of all loaded effects. |
callback | Function to call for every uniform variable. |
user_data | Optional pointer passed to the callback function. |
|
pure virtual |
Finds a specific technique in the loaded effects and returns a handle to it.
effect_name | File name of the effect file the technique is declared in, or nullptr to search in all loaded effects. |
technique_name | Name of the technique to find. |
|
pure virtual |
Finds a specific texture variable in the loaded effects and returns a handle to it.
effect_name | File name of the effect file the variable is declared in, or nullptr to search in all loaded effects. |
variable_name | Name of the texture variable declaration to find. |
|
pure virtual |
Finds a specific uniform variable in the loaded effects and returns a handle to it.
effect_name | File name of the effect file the variable is declared in, or nullptr to search in all loaded effects. |
variable_name | Name of the uniform variable declaration to find. |
|
pure virtual |
Gets the value from an annotation attached to the specified technique as boolean values.
technique | Opaque handle to the technique. |
name | Name of the annotation. |
values | Pointer to an array of booleans that is filled with the values of the annotation. |
count | Number of values to read. |
array_index | Array offset to start reading values from when the annotation is an array. |
|
pure virtual |
Gets the value from an annotation attached to the specified texture variable as boolean values.
variable | Opaque handle to the texture variable. |
name | Name of the annotation. |
values | Pointer to an array of booleans that is filled with the values of the annotation. |
count | Number of values to read. |
array_index | Array offset to start reading values from when the annotation is an array. |
|
pure virtual |
Gets the value from an annotation attached to the specified uniform variable as boolean values.
variable | Opaque handle to the uniform variable. |
name | Name of the annotation. |
values | Pointer to an array of booleans that is filled with the values of the annotation. |
count | Number of values to read. |
array_index | Array offset to start reading values from when the annotation is an array. |
|
pure virtual |
Gets the value from an annotation attached to the specified technique as floating-point values.
technique | Opaque handle to the technique. |
name | Name of the annotation. |
values | Pointer to an array of floating-points that is filled with the values of the annotation. |
count | Number of values to read. |
array_index | Array offset to start reading values from when the annotation is an array. |
|
pure virtual |
Gets the value from an annotation attached to the specified texture variable as floating-point values.
variable | Opaque handle to the texture variable. |
name | Name of the annotation. |
values | Pointer to an array of floating-points that is filled with the values of the annotation. |
count | Number of values to read. |
array_index | Array offset to start reading values from when the annotation is an array. |
|
pure virtual |
Gets the value from an annotation attached to the specified uniform variable as floating-point values.
variable | Opaque handle to the uniform variable. |
name | Name of the annotation. |
values | Pointer to an array of floating-points that is filled with the values of the annotation. |
count | Number of values to read. |
array_index | Array offset to start reading values from when the annotation is an array. |
|
pure virtual |
Gets the value from an annotation attached to the specified technique as signed integer values.
technique | Opaque handle to the technique. |
name | Name of the annotation. |
values | Pointer to an array of signed integers that is filled with the values of the annotation. |
count | Number of values to read. |
array_index | Array offset to start reading values from when the annotation is an array. |
|
pure virtual |
Gets the value from an annotation attached to the specified texture variable as signed integer values.
variable | Opaque handle to the texture variable. |
name | Name of the annotation. |
values | Pointer to an array of signed integers that is filled with the values of the annotation. |
count | Number of values to read. |
array_index | Array offset to start reading values from when the annotation is an array. |
|
pure virtual |
Gets the value from an annotation attached to the specified uniform variable as signed integer values.
variable | Opaque handle to the uniform variable. |
name | Name of the annotation. |
values | Pointer to an array of signed integers that is filled with the values of the annotation. |
count | Number of values to read. |
array_index | Array offset to start reading values from when the annotation is an array. |
|
pure virtual |
Gets the value from a string annotation attached to the specified technique .
technique | Opaque handle to the technique. |
name | Name of the annotation. |
value | Pointer to a string buffer that is filled with the value of the annotation. |
length | Pointer to an integer that contains the size of the string buffer and upon completion is set to the actual length of the string. |
|
inline |
|
pure virtual |
Gets the value from a string annotation attached to the specified texture variable .
variable | Opaque handle to the texture variable. |
name | Name of the annotation. |
value | Pointer to a string buffer that is filled with the value of the annotation. |
length | Pointer to an integer that contains the size of the string buffer and upon completion is set to the actual length of the string. |
|
inline |
|
pure virtual |
Gets the value from a string annotation attached to the specified uniform variable .
variable | Opaque handle to the uniform variable. |
name | Name of the annotation. |
value | Pointer to a string buffer that is filled with the value of the annotation. |
length | Pointer to an integer that contains the size of the string buffer and upon completion is set to the actual length of the string. |
|
inline |
|
pure virtual |
Gets the value from an annotation attached to the specified technique as unsigned integer values.
technique | Opaque handle to the technique. |
name | Name of the annotation. |
values | Pointer to an array of unsigned integers that is filled with the values of the annotation. |
count | Number of values to read. |
array_index | Array offset to start reading values from when the annotation is an array. |
|
pure virtual |
Gets the value from an annotation attached to the specified texture variable as unsigned integer values.
variable | Opaque handle to the texture variable. |
name | Name of the annotation. |
values | Pointer to an array of unsigned integers that is filled with the values of the annotation. |
count | Number of values to read. |
array_index | Array offset to start reading values from when the annotation is an array. |
|
pure virtual |
Gets the value from an annotation attached to the specified uniform variable as unsigned integer values.
variable | Opaque handle to the uniform variable. |
name | Name of the annotation. |
values | Pointer to an array of unsigned integers that is filled with the values of the annotation. |
count | Number of values to read. |
array_index | Array offset to start reading values from when the annotation is an array. |
|
pure virtual |
Gets the main graphics command queue associated with this effect runtime. This may potentially be different from the presentation queue and should be used to execute graphics commands on.
|
pure virtual |
Gets the current absolute position of the mouse cursor in screen coordinates.
out_x | Pointer to a variable that is set to the X coordinate of the current cursor position. |
out_y | Pointer to a variable that is set to the Y coordinate of the current cursor position. |
out_wheel_delta | Optional pointer to a variable that is set to the mouse wheel delta since the last frame. |
|
pure virtual |
Gets the value of global preprocessor definition.
name | Name of the definition. |
value | Pointer to a string buffer that is filled with the value of the definition. |
length | Pointer to an integer that contains the size of the string buffer and upon completion is set to the actual length of the string. |
|
inline |
|
pure virtual |
Gets the current buffer dimensions of the swap chain as used with effect rendering. The returned values are equivalent to BUFFER_WIDTH
and BUFFER_HEIGHT
in ReShade FX.
|
pure virtual |
Gets the name of a technique .
technique | Opaque handle to the technique. |
name | Pointer to a string buffer that is filled with the name of the technique. |
length | Pointer to an integer that contains the size of the string buffer and upon completion is set to the actual length of the string. |
|
inline |
|
pure virtual |
Gets the state of a technique .
technique | Opaque handle to the technique. |
|
pure virtual |
Gets the shader resource view that is bound to the specified texture variable .
variable | Opaque handle to the texture variable. |
out_srv | Pointer to a variable that is set to the shader resource view. |
out_srv_srgb | Pointer to a variable that is set to the sRGB shader resource view. |
|
pure virtual |
Gets the name of a texture variable .
variable | Opaque handle to the texture variable. |
name | Pointer to a string buffer that is filled with the name of the texture variable. |
length | Pointer to an integer that contains the size of the string buffer and upon completion is set to the actual length of the string. |
|
inline |
|
pure virtual |
Gets the value of the specified uniform variable as boolean values.
variable | Opaque handle to the uniform variable. |
values | Pointer to an array of booleans that is filled with the values of this uniform variable. |
count | Number of values to read. |
array_index | Array offset to start reading values from when this uniform variable is an array variable. |
|
pure virtual |
Gets the value of the specified uniform variable as floating-point values.
variable | Opaque handle to the uniform variable. |
values | Pointer to an array of floating-points that is filled with the values of this uniform variable. |
count | Number of values to read. |
array_index | Array offset to start reading values from when this uniform variable is an array variable. |
|
pure virtual |
Gets the value of the specified uniform variable as signed integer values.
variable | Opaque handle to the uniform variable. |
values | Pointer to an array of signed integers that is filled with the values of this uniform variable. |
count | Number of values to read. |
array_index | Array offset to start reading values from when this uniform variable is an array variable. |
|
pure virtual |
Gets the value of the specified uniform variable as unsigned integer values.
variable | Opaque handle to the uniform variable. |
values | Pointer to an array of unsigned integers that is filled with the values of this uniform variable. |
count | Number of values to read. |
array_index | Array offset to start reading values from when this uniform variable is an array variable. |
|
pure virtual |
Gets the name of a uniform variable .
variable | Opaque handle to the uniform variable. |
name | Pointer to a string buffer that is filled with the name of the uniform variable. |
length | Pointer to an integer that contains the size of the string buffer and upon completion is set to the actual length of the string. |
|
inline |
|
pure virtual |
Gets information about the data type of a uniform variable .
variable | Opaque handle to the uniform variable. |
out_base_type | Optional pointer to a variable that is set to the base type of the uniform variable (format::r32_typeless, format::r32_sint, format::r32_uint or format::r32_float). |
out_rows | Optional pointer to a variable that is set to the number of vector rows of the uniform variable type. |
out_columns | Optional pointer to a variable that is set to the number of matrix column of the uniform variable type. |
out_array_length | Optional pointer to a variable that is set to the number of array elements of the uniform variable type. |
|
pure virtual |
Gets the current status of the specified key.
keycode | The virtual key code to check. |
true
if the key is currently pressed down, false
otherwise.
|
pure virtual |
Gets whether the specified key was pressed this frame.
keycode | The virtual key code to check. |
true
if the key was pressed this frame, false
otherwise.
|
pure virtual |
Gets whether the specified key was released this frame.
keycode | The virtual key code to check. |
true
if the key was released this frame, false
otherwise.
|
pure virtual |
Gets the current status of the specified mouse button.
button | The mouse button index to check (0 = left, 1 = middle, 2 = right). |
true
if the mouse button is currently pressed down, false
otherwise.
|
pure virtual |
Gets whether the specified mouse button was pressed this frame.
button | The mouse button index to check (0 = left, 1 = middle, 2 = right). |
true
if the mouse button was pressed this frame, false
otherwise.
|
pure virtual |
Gets whether the specified mouse button was released this frame.
button | The mouse button index to check (0 = left, 1 = middle, 2 = right). |
true
if the mouse button was released this frame, false
otherwise.
|
pure virtual |
Applies post-processing effects to the specified render targets and prevents the usual rendering of effects before swap chain presentation of the current frame. This can be used to force ReShade to render effects at a certain point during the frame to e.g. avoid effects being applied to user interface elements of the application.
The width and height of the specified render target have to match those reported by effect_runtime::get_screenshot_width_and_height! The resource the render target views point to has to be in the resource_usage::render_target state.
cmd_list | Command list to add effect rendering commands to. |
rtv | Render target view to use for passes that write to the back buffer with SRGBWriteEnabled state set to false . |
rtv_srgb | Render target view to use for passes that write to the back buffer with SRGBWriteEnabled state set to true , or zero in which case the view from rtv is used. |
|
pure virtual |
Applies a technique to the specified render targets (regardless of the state of this technique).
The width and height of the specified render target have to match those reported by effect_runtime::get_screenshot_width_and_height! The resource the render target views point to has to be in the resource_usage::render_target state.
technique | Opaque handle to the technique. |
cmd_list | Command list to add effect rendering commands to. |
rtv | Render target view to use for passes that write to the back buffer with SRGBWriteEnabled state set to false . |
rtv_srgb | Render target view to use for passes that write to the back buffer with SRGBWriteEnabled state set to true , or zero in which case the view from rtv is used. |
|
pure virtual |
Defines a global preprocessor definition to the specified value .
name | Name of the definition. |
value | Value of the definition. |
|
pure virtual |
Enables or disable the specified technique .
technique | Opaque handle to the technique. |
enabled | true to enable the technique, or false to disable it. |
|
inline |
Sets the value of the specified uniform variable as a vector of boolean values.
variable | Opaque handle to the uniform variable. |
x | Value of the first component in the vector that is used to update this uniform variable. |
y | Optional value of the second component in the vector that is used to update this uniform variable. |
z | Optional value of the third component in the vector that is used to update this uniform variable. |
w | Optional value of the fourth component in the vector that is used to update this uniform variable. |
|
pure virtual |
Sets the value of the specified uniform variable as boolean values.
variable | Opaque handle to the uniform variable. |
values | Pointer to an array of booleans that are used to update this uniform variable. |
count | Number of values to write. |
array_index | Array offset to start writing values to when this uniform variable is an array variable. |
|
pure virtual |
Sets the value of the specified uniform variable as floating-point values.
variable | Opaque handle to the uniform variable. |
values | Pointer to an array of floating-points that are used to update this uniform variable. |
count | Number of values to write. |
array_index | Array offset to start writing values to when this uniform variable is an array variable. |
|
inline |
Sets the value of the specified uniform variable as a vector of floating-point values.
variable | Opaque handle to the uniform variable. |
x | Value of the first component in the vector that is used to update this uniform variable. |
y | Optional value of the second component in the vector that is used to update this uniform variable. |
z | Optional value of the third component in the vector that is used to update this uniform variable. |
w | Optional value of the fourth component in the vector that is used to update this uniform variable. |
|
pure virtual |
Sets the value of the specified uniform variable as signed integer values.
variable | Opaque handle to the uniform variable. |
values | Pointer to an array of signed integers that are used to update this uniform variable. |
count | Number of values to write. |
array_index | Array offset to start writing values to when this uniform variable is an array variable. |
|
inline |
Sets the value of the specified uniform variable as a vector of signed integer values.
variable | Opaque handle to the uniform variable. |
x | Value of the first component in the vector that is used to update this uniform variable. |
y | Optional value of the second component in the vector that is used to update this uniform variable. |
z | Optional value of the third component in the vector that is used to update this uniform variable. |
w | Optional value of the fourth component in the vector that is used to update this uniform variable. |
|
pure virtual |
Sets the value of the specified uniform variable as unsigned integer values.
variable | Opaque handle to the uniform variable. |
values | Pointer to an array of unsigned integers that are used to update this uniform variable. |
count | Number of values to write. |
array_index | Array offset to start writing values to when this uniform variable is an array variable. |
|
inline |
Sets the value of the specified uniform variable as a vector of unsigned integer values.
variable | Opaque handle to the uniform variable. |
x | Value of the first component in the vector that is used to update this uniform variable. |
y | Optional value of the second component in the vector that is used to update this uniform variable. |
z | Optional value of the third component in the vector that is used to update this uniform variable. |
w | Optional value of the fourth component in the vector that is used to update this uniform variable. |
|
pure virtual |
Uploads 32 bits-per-pixel RGBA image data to the specified texture variable .
variable | Opaque handle to the texture variable. |
width | Width of the image data. |
height | Height of the image data. |
pixels | Pointer to an array of width * height * 4 bytes the image data is read from. |
|
pure virtual |
Binds a new shader resource view to all texture variables that use the specified semantic .
The resource the shader resource views point to has to be in the resource_usage::shader_resource state at the time render_effects is executed.
semantic | ReShade FX semantic to filter textures to update by (texture name : SEMANTIC ). |
srv | Shader resource view to use for samplers with SRGBTexture state set to false . |
srv_srgb | Shader resource view to use for samplers with SRGBTexture state set to true , or zero in which case the view from srv is used. |