ReShade.psc File Reference

Functions
bool	OK () global
	Check whether ReShade is loaded.
int	LogError (string asMessage) global
	Log an error message.
int	LogWarning (string asMessage) global
	Log a warning message.
int	LogInfo (string asMessage) global
	Log an info message.
int	LogDebug (string asMessage) global
	Log a debug message.
int	SetTechniqueState (string asTechniquePattern, bool abEnabled, int aiRuntime=0) global
	Set state (enabled or disabled) of techniques whose name matches a regular expression.
int	GetTechniqueState (string asTechniquePattern, bool abEnabled, int aiRuntime=0) global
	Check whether all techniques whose names match a regular expression are in a specified state (enabled or disabled).
int	CheckTechniqueState (string asTechniquePattern, bool abEnabled, int aiRuntime=0) global
	Count techniques in a specified state (enabled or disabled) whose names match a regular expression.
int	SetPreprocessorDefinition (string asName, string asValue, int aiRuntime=0) global
	Define a preprocessor definition.

Variables
int Property	NO_RESHADE = -1 AutoReadOnly
	ReShade is not loaded.
int Property	BAD_RUNTIME = -2 AutoReadOnly
	Requested ReShade runtime is not available.
int Property	BAD_REGEX = -3 AutoReadOnly
	Regular expression is malformed.

Function Documentation

CheckTechniqueState()

int CheckTechniqueState	(	string	asTechniquePattern,
		bool	abEnabled,
		int	aiRuntime = 0
	)

Count techniques in a specified state (enabled or disabled) whose names match a regular expression.

Parameters

asTechniquePattern	Regular expression to match technique names.
abEnabled	Whether to count enabled (true) or disabled (false) techniques.
aiRuntime	Target ReShade runtime.

Returns

Number of matching techniques that are in the specified state, or a negative error code.

Return values

NO_RESHADE
BAD_RUNTIME
BAD_REGEX

GetTechniqueState()

int GetTechniqueState	(	string	asTechniquePattern,
		bool	abEnabled,
		int	aiRuntime = 0
	)

Check whether all techniques whose names match a regular expression are in a specified state (enabled or disabled).

Parameters

asTechniquePattern	Regular expression to match technique names.
abEnabled	Whether to check for enabled (true) or disabled (false) techniques.
aiRuntime	Target ReShade runtime.

Returns

1 if all matching techniques are in the specified state, otherwise 0 or a negative error code.

Return values

NO_RESHADE
BAD_RUNTIME
BAD_REGEX

LogDebug()

int LogDebug

(

string

asMessage

)

Log a debug message.

Parameters

asMessage

The message to log.

Return values

0	The message was logged successfully.
NO_RESHADE

LogError()

int LogError

(

string

asMessage

)

Log an error message.

Parameters

asMessage

The message to log.

Return values

0	The message was logged successfully.
NO_RESHADE

LogInfo()

int LogInfo

(

string

asMessage

)

Log an info message.

Parameters

asMessage

The message to log.

Return values

0	The message was logged successfully.
NO_RESHADE

LogWarning()

int LogWarning

(

string

asMessage

)

Log a warning message.

Parameters

asMessage

The message to log.

Return values

0	The message was logged successfully.
NO_RESHADE

OK()

bool OK

(

)

Check whether ReShade is loaded.

Returns

true if ReShade is loaded, false otherwise.

SetPreprocessorDefinition()

int SetPreprocessorDefinition	(	string	asName,
		string	asValue,
		int	aiRuntime = 0
	)

Define a preprocessor definition.

Parameters

asName	Name of the definition.
asValue	Value of the definition.

Return values

0	The definition was defined successfully.
NO_RESHADE

SetTechniqueState()

int SetTechniqueState	(	string	asTechniquePattern,
		bool	abEnabled,
		int	aiRuntime = 0
	)

Set state (enabled or disabled) of techniques whose name matches a regular expression.

Parameters

asTechniquePattern	Regular expression to match technique names.
abEnabled	Whether to enable (true) or disable (false) matching techniques.
aiRuntime	Target ReShade runtime.

Returns

Number of matching techniques whose state was set, or a negative error code.

Return values

NO_RESHADE
BAD_RUNTIME
BAD_REGEX

Variable Documentation

BAD_REGEX

int Property BAD_REGEX = -3 AutoReadOnly

Regular expression is malformed.

BAD_RUNTIME

int Property BAD_RUNTIME = -2 AutoReadOnly

Requested ReShade runtime is not available.

NO_RESHADE

int Property NO_RESHADE = -1 AutoReadOnly

ReShade is not loaded.