srp
software rendering pipeline
Loading...
Searching...
No Matches

Runtime state management. More...

Collaboration diagram for Context:
enum  SRPInterpolationMode { SRP_INTERPOLATION_MODE_PERSPECTIVE , SRP_INTERPOLATION_MODE_AFFINE }
 
enum  SRPContextParameter { SRP_CONTEXT_MESSAGE_CALLBACK , SRP_CONTEXT_MESSAGE_CALLBACK_USER_PARAMETER , SRP_CONTEXT_INTERPOLATION_MODE }
 
typedef enum SRPInterpolationMode SRPInterpolationMode
 
typedef struct SRPContext SRPContext
 
typedef enum SRPContextParameter SRPContextParameter
 
void srpNewContext (SRPContext *pContext)
 
void srpContextSetP (SRPContextParameter contextParameter, const void *data)
 
void srpContextSetI (SRPContextParameter contextParameter, int data)
 
void * srpContextGetP (SRPContextParameter contextParameter)
 
int srpContextGetI (SRPContextParameter contextParameter)
 
enum  MessageType { SRP_MESSAGE_ERROR , SRP_MESSAGE_WARNING }
 
enum  MessageSeverity { SRP_MESSAGE_SEVERITY_LOW , SRP_MESSAGE_SEVERITY_MODERATE , SRP_MESSAGE_SEVERITY_HIGH }
 
typedef enum MessageType SRPMessageType
 
typedef enum MessageSeverity SRPMessageSeverity
 
typedef void(* SRPMessageCallbackType) (SRPMessageType type, SRPMessageSeverity severity, const char *sourceFunction, const char *message, void *userParameter)
 

Detailed Description

Runtime state management.

Typedef Documentation

◆ SRPContext

typedef struct SRPContext SRPContext

Holds runtime settings. This always needs to be declared as SRPContext srpContext in user programs and initialized with srpNewContext()

◆ SRPContextParameter

Possible arguments to srpContextSet...

◆ SRPInterpolationMode

Available attribute interpolation types

◆ SRPMessageCallbackType

typedef void(* SRPMessageCallbackType) (SRPMessageType type, SRPMessageSeverity severity, const char *sourceFunction, const char *message, void *userParameter)

A function of this type may be defined by user to handle the messages generated by the library (errors, warnings, etc.)

See also
SRPContext

◆ SRPMessageSeverity

Represents the message severity

See also
SRPMessageCallbackType

◆ SRPMessageType

Represents the message type (error, warning, etc.)

See also
SRPMessageCallbackType

Enumeration Type Documentation

◆ MessageSeverity

Represents the message severity

See also
SRPMessageCallbackType

◆ MessageType

Represents the message type (error, warning, etc.)

See also
SRPMessageCallbackType

◆ SRPContextParameter

Possible arguments to srpContextSet...

◆ SRPInterpolationMode

Available attribute interpolation types

Function Documentation

◆ srpContextGetI()

int srpContextGetI ( SRPContextParameter  contextParameter)

Get an integer/enum parameter in the context

Parameters
[in]contextParameterThe context parameter you want to get
Returns
Requested parameter or 0 on error

◆ srpContextGetP()

void * srpContextGetP ( SRPContextParameter  contextParameter)

Get a pointer parameter in the context

Parameters
[in]contextParameterThe context parameter you want to get
Returns
Requested parameter or NULL on error

◆ srpContextSetI()

void srpContextSetI ( SRPContextParameter  contextParameter,
int  data 
)

Set an integer/enum parameter in the context

Parameters
[in]contextParameterThe context parameter you want to modify
[in]dataThe value you want to assign to specified context parameter

◆ srpContextSetP()

void srpContextSetP ( SRPContextParameter  contextParameter,
const void *  data 
)

Set a pointer parameter in the context

Parameters
[in]contextParameterThe context parameter you want to modify
[in]dataThe pointer you want to assign to specified context parameter
Todo:
Is this cast OK?

◆ srpNewContext()

void srpNewContext ( SRPContext pContext)

Initialize the context

Parameters
[in]pContextThe pointer to context