ai_shader_parameval.h

Go to the documentation of this file.

// Copyright 2020 Autodesk, Inc.  All rights reserved.
//
// Use of this software is subject to the terms of the Autodesk license
// agreement provided at the time of installation or download, or which
// otherwise accompanies this software in either electronic or hard copy form.

#pragma once
#include "ai_array.h"
#include "ai_closure.h"
#include "ai_color.h"
#include "ai_matrix.h"
#include "ai_vector.h"
#include <stdint.h> // uint32_t etc

// forward declarations
struct AtShaderGlobals;
struct AtNode;

#define AiShaderEvalParamByte(pid)    AiShaderEvalParamFuncByte   (sg,node,pid)
#define AiShaderEvalParamInt(pid)     AiShaderEvalParamFuncInt    (sg,node,pid)
#define AiShaderEvalParamUInt(pid)    AiShaderEvalParamFuncUInt   (sg,node,pid)
#define AiShaderEvalParamBool(pid)    AiShaderEvalParamFuncBool   (sg,node,pid)
#define AiShaderEvalParamFlt(pid)     AiShaderEvalParamFuncFlt    (sg,node,pid)
#define AiShaderEvalParamRGB(pid)     AiShaderEvalParamFuncRGB    (sg,node,pid)
#define AiShaderEvalParamRGBA(pid)    AiShaderEvalParamFuncRGBA   (sg,node,pid)
#define AiShaderEvalParamVec(pid)     AiShaderEvalParamFuncVec    (sg,node,pid)
#define AiShaderEvalParamVec2(pid)    AiShaderEvalParamFuncVec2   (sg,node,pid)
#define AiShaderEvalParamStr(pid)     AiShaderEvalParamFuncStr    (sg,node,pid)
#define AiShaderEvalParamPtr(pid)     AiShaderEvalParamFuncPtr    (sg,node,pid)
#define AiShaderEvalParamArray(pid)   AiShaderEvalParamFuncArray  (sg,node,pid)
#define AiShaderEvalParamMtx(pid)     AiShaderEvalParamFuncMtx    (sg,node,pid)
#define AiShaderEvalParamEnum(pid)    AiShaderEvalParamFuncEnum   (sg,node,pid)
#define AiShaderEvalParamClosure(pid) AiShaderEvalParamFuncClosure(sg,node,pid)
#define AiShaderEvalParamOpacity(pid) AiShaderEvalParamFuncOpacity(sg,node,pid)
/*\}*/

/*\}*/

/*
 * Function form, only if you want to explicitly change shader globals and/or
 * node yourself. Otherwise it is recommended that you use the macros provided
 * above.
 *
 * \param sg    A shader globals context
 * \param node  The shader node whose parameter we want to evaluate
 * \param pid   Index in the shader's parameter enum list
 * \return      Parameter value of the corresponding type
 */
AI_API uint8_t       AiShaderEvalParamFuncByte   (AtShaderGlobals* sg, const AtNode* node, int pid);
AI_API int           AiShaderEvalParamFuncInt    (AtShaderGlobals* sg, const AtNode* node, int pid);
AI_API unsigned int  AiShaderEvalParamFuncUInt   (AtShaderGlobals* sg, const AtNode* node, int pid);
AI_API bool          AiShaderEvalParamFuncBool   (AtShaderGlobals* sg, const AtNode* node, int pid);
AI_API float         AiShaderEvalParamFuncFlt    (AtShaderGlobals* sg, const AtNode* node, int pid);
AI_API AtRGB         AiShaderEvalParamFuncRGB    (AtShaderGlobals* sg, const AtNode* node, int pid);
AI_API AtRGBA        AiShaderEvalParamFuncRGBA   (AtShaderGlobals* sg, const AtNode* node, int pid);
AI_API AtVector      AiShaderEvalParamFuncVec    (AtShaderGlobals* sg, const AtNode* node, int pid);
AI_API AtVector2     AiShaderEvalParamFuncVec2   (AtShaderGlobals* sg, const AtNode* node, int pid);
AI_API AtString      AiShaderEvalParamFuncStr    (AtShaderGlobals* sg, const AtNode* node, int pid);
AI_API void*         AiShaderEvalParamFuncPtr    (AtShaderGlobals* sg, const AtNode* node, int pid);
AI_API AtArray*      AiShaderEvalParamFuncArray  (AtShaderGlobals* sg, const AtNode* node, int pid);
AI_API AtMatrix*     AiShaderEvalParamFuncMtx    (AtShaderGlobals* sg, const AtNode* node, int pid);
AI_API int           AiShaderEvalParamFuncEnum   (AtShaderGlobals* sg, const AtNode* node, int pid);
AI_API AtClosureList AiShaderEvalParamFuncClosure(AtShaderGlobals* sg, const AtNode* node, int pid);
AI_API AtRGB         AiShaderEvalParamFuncOpacity(AtShaderGlobals* sg, const AtNode* node, int pid);