MRIRenderObject.h

Go to the documentation of this file.

#pragma once
 
#include <MRCMesh/MRRenderModelParameters.h>
#include <MRCMesh/MRVector3.h>
#include <MRCMesh/MRVector4.h>
#include <MRCMesh/MRViewportId.h>
#include <MRCMisc/common.h>
#include <MRCMisc/exports.h>
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct MR_Matrix4f MR_Matrix4f; // Defined in `#include <MRCMesh/MRMatrix4.h>`.
typedef struct MR_Plane3f MR_Plane3f; // Defined in `#include <MRCMesh/MRPlane3.h>`.
typedef struct MR_std_vector_std_shared_ptr_MR_BasicUiRenderTask MR_std_vector_std_shared_ptr_MR_BasicUiRenderTask; // Defined in `#include <MRCMisc/std_vector_std_shared_ptr_MR_BasicUiRenderTask.h>`.
 
 
typedef int32_t MR_DepthFunction;
enum // MR_DepthFunction
{
    MR_DepthFunction_Never = 0,
    MR_DepthFunction_Less = 1,
    MR_DepthFunction_Equal = 2,
    MR_DepthFunction_Greater = 4,
    MR_DepthFunction_LessOrEqual = 3,
    MR_DepthFunction_GreaterOrEqual = 6,
    MR_DepthFunction_NotEqual = 5,
    MR_DepthFunction_Always = 7,
    // usually "Less" but may differ for different object types
    MR_DepthFunction_Default = 8,
};
 
typedef struct MR_BaseRenderParams MR_BaseRenderParams;
 
typedef struct MR_ModelBaseRenderParams MR_ModelBaseRenderParams;
 
typedef struct MR_ModelRenderParams MR_ModelRenderParams;
 
typedef struct MR_BasicUiRenderTask MR_BasicUiRenderTask;
 
typedef int32_t MR_BasicUiRenderTask_InteractionMask;
enum // MR_BasicUiRenderTask_InteractionMask
{
    MR_BasicUiRenderTask_InteractionMask_mouseHover = 1,
    MR_BasicUiRenderTask_InteractionMask_mouseScroll = 2,
};
 
typedef struct MR_BasicUiRenderTask_BackwardPassParams MR_BasicUiRenderTask_BackwardPassParams;
 
typedef struct MR_UiRenderParams MR_UiRenderParams;
 
typedef struct MR_UiRenderManager MR_UiRenderManager;
 
typedef struct MR_IRenderObject MR_IRenderObject;
 
MRC_API MR_DepthFunction MR_bitand_MR_DepthFunction(MR_DepthFunction a, MR_DepthFunction b);
 
MRC_API MR_DepthFunction MR_bitor_MR_DepthFunction(MR_DepthFunction a, MR_DepthFunction b);
 
MRC_API MR_DepthFunction MR_compl_MR_DepthFunction(MR_DepthFunction a);
 
MRC_API MR_DepthFunction *MR_bitand_assign_MR_DepthFunction(MR_DepthFunction *a, MR_DepthFunction b);
 
MRC_API MR_DepthFunction *MR_bitor_assign_MR_DepthFunction(MR_DepthFunction *a, MR_DepthFunction b);
 
MRC_API MR_DepthFunction MR_mul_MR_DepthFunction_bool(MR_DepthFunction a, bool b);
 
MRC_API MR_DepthFunction MR_mul_bool_MR_DepthFunction(bool a, MR_DepthFunction b);
 
MRC_API MR_DepthFunction *MR_mul_assign_MR_DepthFunction_bool(MR_DepthFunction *a, bool b);
 
MRC_API const MR_Matrix4f *MR_BaseRenderParams_Get_viewMatrix(const MR_BaseRenderParams *_this);
 
MRC_API const MR_Matrix4f *MR_BaseRenderParams_Get_projMatrix(const MR_BaseRenderParams *_this);
 
// id of the viewport
MRC_API const MR_ViewportId *MR_BaseRenderParams_Get_viewportId(const MR_BaseRenderParams *_this);
 
// id of the viewport
MRC_API void MR_BaseRenderParams_Set_viewportId(MR_BaseRenderParams *_this, MR_ViewportId value);
 
// id of the viewport
MRC_API MR_ViewportId *MR_BaseRenderParams_GetMutable_viewportId(MR_BaseRenderParams *_this);
 
// viewport x0, y0, width, height
MRC_API const MR_Vector4i *MR_BaseRenderParams_Get_viewport(const MR_BaseRenderParams *_this);
 
// viewport x0, y0, width, height
MRC_API void MR_BaseRenderParams_Set_viewport(MR_BaseRenderParams *_this, MR_Vector4i value);
 
// viewport x0, y0, width, height
MRC_API MR_Vector4i *MR_BaseRenderParams_GetMutable_viewport(MR_BaseRenderParams *_this);
 
MRC_API MR_BaseRenderParams *MR_BaseRenderParams_ConstructFromAnother(const MR_BaseRenderParams *_other);
 
MRC_API MR_BaseRenderParams *MR_BaseRenderParams_ConstructFrom(const MR_Matrix4f *viewMatrix, const MR_Matrix4f *projMatrix, MR_ViewportId viewportId, MR_Vector4i viewport);
 
MRC_API const MR_BaseRenderParams *MR_BaseRenderParams_OffsetPtr(const MR_BaseRenderParams *ptr, ptrdiff_t i);
 
MRC_API MR_BaseRenderParams *MR_BaseRenderParams_OffsetMutablePtr(MR_BaseRenderParams *ptr, ptrdiff_t i);
 
MRC_API const MR_ModelBaseRenderParams *MR_BaseRenderParams_StaticDowncastTo_MR_ModelBaseRenderParams(const MR_BaseRenderParams *object);
 
MRC_API MR_ModelBaseRenderParams *MR_BaseRenderParams_MutableStaticDowncastTo_MR_ModelBaseRenderParams(MR_BaseRenderParams *object);
 
MRC_API const MR_ModelRenderParams *MR_BaseRenderParams_StaticDowncastTo_MR_ModelRenderParams(const MR_BaseRenderParams *object);
 
MRC_API MR_ModelRenderParams *MR_BaseRenderParams_MutableStaticDowncastTo_MR_ModelRenderParams(MR_BaseRenderParams *object);
 
MRC_API const MR_UiRenderParams *MR_BaseRenderParams_StaticDowncastTo_MR_UiRenderParams(const MR_BaseRenderParams *object);
 
MRC_API MR_UiRenderParams *MR_BaseRenderParams_MutableStaticDowncastTo_MR_UiRenderParams(MR_BaseRenderParams *object);
 
MRC_API void MR_BaseRenderParams_Destroy(const MR_BaseRenderParams *_this);
 
MRC_API void MR_BaseRenderParams_DestroyArray(const MR_BaseRenderParams *_this);
 
MRC_API const MR_Matrix4f *MR_ModelBaseRenderParams_Get_modelMatrix(const MR_ModelBaseRenderParams *_this);
 
// viewport clip plane (it is not applied while object does not have clipping flag set)
MRC_API const MR_Plane3f *MR_ModelBaseRenderParams_Get_clipPlane(const MR_ModelBaseRenderParams *_this);
 
MRC_API const MR_DepthFunction *MR_ModelBaseRenderParams_Get_depthFunction(const MR_ModelBaseRenderParams *_this);
 
MRC_API void MR_ModelBaseRenderParams_Set_depthFunction(MR_ModelBaseRenderParams *_this, MR_DepthFunction value);
 
MRC_API MR_DepthFunction *MR_ModelBaseRenderParams_GetMutable_depthFunction(MR_ModelBaseRenderParams *_this);
 
MRC_API MR_ModelBaseRenderParams *MR_ModelBaseRenderParams_ConstructFromAnother(const MR_ModelBaseRenderParams *_other);
 
MRC_API const MR_ModelBaseRenderParams *MR_ModelBaseRenderParams_OffsetPtr(const MR_ModelBaseRenderParams *ptr, ptrdiff_t i);
 
MRC_API MR_ModelBaseRenderParams *MR_ModelBaseRenderParams_OffsetMutablePtr(MR_ModelBaseRenderParams *ptr, ptrdiff_t i);
 
MRC_API const MR_BaseRenderParams *MR_ModelBaseRenderParams_UpcastTo_MR_BaseRenderParams(const MR_ModelBaseRenderParams *object);
 
MRC_API MR_BaseRenderParams *MR_ModelBaseRenderParams_MutableUpcastTo_MR_BaseRenderParams(MR_ModelBaseRenderParams *object);
 
MRC_API const MR_ModelRenderParams *MR_ModelBaseRenderParams_StaticDowncastTo_MR_ModelRenderParams(const MR_ModelBaseRenderParams *object);
 
MRC_API MR_ModelRenderParams *MR_ModelBaseRenderParams_MutableStaticDowncastTo_MR_ModelRenderParams(MR_ModelBaseRenderParams *object);
 
MRC_API void MR_ModelBaseRenderParams_Destroy(const MR_ModelBaseRenderParams *_this);
 
MRC_API void MR_ModelBaseRenderParams_DestroyArray(const MR_ModelBaseRenderParams *_this);
 
// normal matrix, only necessary for triangles rendering
MRC_API const MR_Matrix4f *const *MR_ModelRenderParams_Get_normMatrixPtr(const MR_ModelRenderParams *_this);
 
// normal matrix, only necessary for triangles rendering
MRC_API void MR_ModelRenderParams_Set_normMatrixPtr(MR_ModelRenderParams *_this, const MR_Matrix4f *value);
 
// normal matrix, only necessary for triangles rendering
MRC_API const MR_Matrix4f **MR_ModelRenderParams_GetMutable_normMatrixPtr(MR_ModelRenderParams *_this);
 
// position of light source
MRC_API const MR_Vector3f *MR_ModelRenderParams_Get_lightPos(const MR_ModelRenderParams *_this);
 
// position of light source
MRC_API void MR_ModelRenderParams_Set_lightPos(MR_ModelRenderParams *_this, MR_Vector3f value);
 
// position of light source
MRC_API MR_Vector3f *MR_ModelRenderParams_GetMutable_lightPos(MR_ModelRenderParams *_this);
 
// if true, the object can use the alpha sorting shader if it wants to
MRC_API const bool *MR_ModelRenderParams_Get_allowAlphaSort(const MR_ModelRenderParams *_this);
 
// if true, the object can use the alpha sorting shader if it wants to
MRC_API void MR_ModelRenderParams_Set_allowAlphaSort(MR_ModelRenderParams *_this, bool value);
 
// if true, the object can use the alpha sorting shader if it wants to
MRC_API bool *MR_ModelRenderParams_GetMutable_allowAlphaSort(MR_ModelRenderParams *_this);
 
// Only perform rendering if `bool( passMask & desiredPass )` is true.
MRC_API const MR_RenderModelPassMask *MR_ModelRenderParams_Get_passMask(const MR_ModelRenderParams *_this);
 
// Only perform rendering if `bool( passMask & desiredPass )` is true.
MRC_API void MR_ModelRenderParams_Set_passMask(MR_ModelRenderParams *_this, MR_RenderModelPassMask value);
 
// Only perform rendering if `bool( passMask & desiredPass )` is true.
MRC_API MR_RenderModelPassMask *MR_ModelRenderParams_GetMutable_passMask(MR_ModelRenderParams *_this);
 
MRC_API MR_ModelRenderParams *MR_ModelRenderParams_ConstructFromAnother(const MR_ModelRenderParams *_other);
 
MRC_API const MR_ModelRenderParams *MR_ModelRenderParams_OffsetPtr(const MR_ModelRenderParams *ptr, ptrdiff_t i);
 
MRC_API MR_ModelRenderParams *MR_ModelRenderParams_OffsetMutablePtr(MR_ModelRenderParams *ptr, ptrdiff_t i);
 
MRC_API const MR_BaseRenderParams *MR_ModelRenderParams_UpcastTo_MR_BaseRenderParams(const MR_ModelRenderParams *object);
 
MRC_API MR_BaseRenderParams *MR_ModelRenderParams_MutableUpcastTo_MR_BaseRenderParams(MR_ModelRenderParams *object);
 
MRC_API const MR_ModelBaseRenderParams *MR_ModelRenderParams_UpcastTo_MR_ModelBaseRenderParams(const MR_ModelRenderParams *object);
 
MRC_API MR_ModelBaseRenderParams *MR_ModelRenderParams_MutableUpcastTo_MR_ModelBaseRenderParams(MR_ModelRenderParams *object);
 
MRC_API void MR_ModelRenderParams_Destroy(const MR_ModelRenderParams *_this);
 
MRC_API void MR_ModelRenderParams_DestroyArray(const MR_ModelRenderParams *_this);
 
MRC_API const float *MR_BasicUiRenderTask_Get_renderTaskDepth(const MR_BasicUiRenderTask *_this);
 
MRC_API void MR_BasicUiRenderTask_Set_renderTaskDepth(MR_BasicUiRenderTask *_this, float value);
 
MRC_API float *MR_BasicUiRenderTask_GetMutable_renderTaskDepth(MR_BasicUiRenderTask *_this);
 
MRC_API void MR_BasicUiRenderTask_Destroy(const MR_BasicUiRenderTask *_this);
 
MRC_API void MR_BasicUiRenderTask_DestroyArray(const MR_BasicUiRenderTask *_this);
 
MRC_API void MR_BasicUiRenderTask_earlyBackwardPass(MR_BasicUiRenderTask *_this, const MR_BasicUiRenderTask_BackwardPassParams *params);
 
MRC_API void MR_BasicUiRenderTask_renderPass(MR_BasicUiRenderTask *_this);
 
MRC_API const MR_BasicUiRenderTask *MR_BasicUiRenderTask_OffsetPtr(const MR_BasicUiRenderTask *ptr, ptrdiff_t i);
 
MRC_API MR_BasicUiRenderTask *MR_BasicUiRenderTask_OffsetMutablePtr(MR_BasicUiRenderTask *ptr, ptrdiff_t i);
 
MRC_API MR_BasicUiRenderTask_InteractionMask MR_bitand_MR_BasicUiRenderTask_InteractionMask(MR_BasicUiRenderTask_InteractionMask a, MR_BasicUiRenderTask_InteractionMask b);
 
MRC_API MR_BasicUiRenderTask_InteractionMask MR_bitor_MR_BasicUiRenderTask_InteractionMask(MR_BasicUiRenderTask_InteractionMask a, MR_BasicUiRenderTask_InteractionMask b);
 
MRC_API MR_BasicUiRenderTask_InteractionMask MR_compl_MR_BasicUiRenderTask_InteractionMask(MR_BasicUiRenderTask_InteractionMask a);
 
MRC_API MR_BasicUiRenderTask_InteractionMask *MR_bitand_assign_MR_BasicUiRenderTask_InteractionMask(MR_BasicUiRenderTask_InteractionMask *a, MR_BasicUiRenderTask_InteractionMask b);
 
MRC_API MR_BasicUiRenderTask_InteractionMask *MR_bitor_assign_MR_BasicUiRenderTask_InteractionMask(MR_BasicUiRenderTask_InteractionMask *a, MR_BasicUiRenderTask_InteractionMask b);
 
MRC_API MR_BasicUiRenderTask_InteractionMask MR_mul_MR_BasicUiRenderTask_InteractionMask_bool(MR_BasicUiRenderTask_InteractionMask a, bool b);
 
MRC_API MR_BasicUiRenderTask_InteractionMask MR_mul_bool_MR_BasicUiRenderTask_InteractionMask(bool a, MR_BasicUiRenderTask_InteractionMask b);
 
MRC_API MR_BasicUiRenderTask_InteractionMask *MR_mul_assign_MR_BasicUiRenderTask_InteractionMask_bool(MR_BasicUiRenderTask_InteractionMask *a, bool b);
 
// Which interactions should be blocked by this object.
// This is passed along between all `renderUi()` calls in a single frame, and then the end result is used.
MRC_API const MR_BasicUiRenderTask_InteractionMask *MR_BasicUiRenderTask_BackwardPassParams_Get_consumedInteractions(const MR_BasicUiRenderTask_BackwardPassParams *_this);
 
// Which interactions should be blocked by this object.
// This is passed along between all `renderUi()` calls in a single frame, and then the end result is used.
MRC_API void MR_BasicUiRenderTask_BackwardPassParams_Set_consumedInteractions(MR_BasicUiRenderTask_BackwardPassParams *_this, MR_BasicUiRenderTask_InteractionMask value);
 
// Which interactions should be blocked by this object.
// This is passed along between all `renderUi()` calls in a single frame, and then the end result is used.
MRC_API MR_BasicUiRenderTask_InteractionMask *MR_BasicUiRenderTask_BackwardPassParams_GetMutable_consumedInteractions(MR_BasicUiRenderTask_BackwardPassParams *_this);
 
MRC_API MR_BasicUiRenderTask_BackwardPassParams *MR_BasicUiRenderTask_BackwardPassParams_DefaultConstruct(void);
 
MRC_API MR_BasicUiRenderTask_BackwardPassParams *MR_BasicUiRenderTask_BackwardPassParams_DefaultConstructArray(size_t num_elems);
 
MRC_API MR_BasicUiRenderTask_BackwardPassParams *MR_BasicUiRenderTask_BackwardPassParams_ConstructFrom(MR_BasicUiRenderTask_InteractionMask consumedInteractions);
 
MRC_API const MR_BasicUiRenderTask_BackwardPassParams *MR_BasicUiRenderTask_BackwardPassParams_OffsetPtr(const MR_BasicUiRenderTask_BackwardPassParams *ptr, ptrdiff_t i);
 
MRC_API MR_BasicUiRenderTask_BackwardPassParams *MR_BasicUiRenderTask_BackwardPassParams_OffsetMutablePtr(MR_BasicUiRenderTask_BackwardPassParams *ptr, ptrdiff_t i);
 
MRC_API MR_BasicUiRenderTask_BackwardPassParams *MR_BasicUiRenderTask_BackwardPassParams_ConstructFromAnother(const MR_BasicUiRenderTask_BackwardPassParams *_other);
 
MRC_API void MR_BasicUiRenderTask_BackwardPassParams_Destroy(const MR_BasicUiRenderTask_BackwardPassParams *_this);
 
MRC_API void MR_BasicUiRenderTask_BackwardPassParams_DestroyArray(const MR_BasicUiRenderTask_BackwardPassParams *_this);
 
MRC_API MR_BasicUiRenderTask_BackwardPassParams *MR_BasicUiRenderTask_BackwardPassParams_AssignFromAnother(MR_BasicUiRenderTask_BackwardPassParams *_this, const MR_BasicUiRenderTask_BackwardPassParams *_other);
 
// If nothing else is hovered, this returns true and writes `mouseHover` to `consumedInteractions`.
MRC_API bool MR_BasicUiRenderTask_BackwardPassParams_tryConsumeMouseHover(const MR_BasicUiRenderTask_BackwardPassParams *_this);
 
MRC_API const float *MR_UiRenderParams_Get_scale(const MR_UiRenderParams *_this);
 
MRC_API void MR_UiRenderParams_Set_scale(MR_UiRenderParams *_this, float value);
 
MRC_API float *MR_UiRenderParams_GetMutable_scale(MR_UiRenderParams *_this);
 
// Those are Z-sorted and then executed.
MRC_API MR_std_vector_std_shared_ptr_MR_BasicUiRenderTask *const *MR_UiRenderParams_Get_tasks(const MR_UiRenderParams *_this);
 
// Those are Z-sorted and then executed.
MRC_API void MR_UiRenderParams_Set_tasks(MR_UiRenderParams *_this, MR_std_vector_std_shared_ptr_MR_BasicUiRenderTask *value);
 
// Those are Z-sorted and then executed.
MRC_API MR_std_vector_std_shared_ptr_MR_BasicUiRenderTask **MR_UiRenderParams_GetMutable_tasks(MR_UiRenderParams *_this);
 
MRC_API MR_UiRenderParams *MR_UiRenderParams_ConstructFromAnother(const MR_UiRenderParams *_other);
 
MRC_API const MR_UiRenderParams *MR_UiRenderParams_OffsetPtr(const MR_UiRenderParams *ptr, ptrdiff_t i);
 
MRC_API MR_UiRenderParams *MR_UiRenderParams_OffsetMutablePtr(MR_UiRenderParams *ptr, ptrdiff_t i);
 
MRC_API const MR_BaseRenderParams *MR_UiRenderParams_UpcastTo_MR_BaseRenderParams(const MR_UiRenderParams *object);
 
MRC_API MR_BaseRenderParams *MR_UiRenderParams_MutableUpcastTo_MR_BaseRenderParams(MR_UiRenderParams *object);
 
MRC_API void MR_UiRenderParams_Destroy(const MR_UiRenderParams *_this);
 
MRC_API void MR_UiRenderParams_DestroyArray(const MR_UiRenderParams *_this);
 
MRC_API MR_UiRenderManager *MR_UiRenderManager_DefaultConstruct(void);
 
MRC_API MR_UiRenderManager *MR_UiRenderManager_DefaultConstructArray(size_t num_elems);
 
MRC_API const MR_UiRenderManager *MR_UiRenderManager_OffsetPtr(const MR_UiRenderManager *ptr, ptrdiff_t i);
 
MRC_API MR_UiRenderManager *MR_UiRenderManager_OffsetMutablePtr(MR_UiRenderManager *ptr, ptrdiff_t i);
 
MRC_API void MR_UiRenderManager_Destroy(const MR_UiRenderManager *_this);
 
MRC_API void MR_UiRenderManager_DestroyArray(const MR_UiRenderManager *_this);
 
// This is called before doing `IRenderObject::renderUi()` on even object in a viewport. Each viewport is rendered separately.
MRC_API void MR_UiRenderManager_preRenderViewport(MR_UiRenderManager *_this, MR_ViewportId viewport);
 
// This is called after doing `IRenderObject::renderUi()` on even object in a viewport. Each viewport is rendered separately.
MRC_API void MR_UiRenderManager_postRenderViewport(MR_UiRenderManager *_this, MR_ViewportId viewport);
 
// Returns the parameters for the `IRenderObject::earlyBackwardPass()`.
// This will be called exactly once per viewport, each time the UI in it is rendered.
MRC_API MR_BasicUiRenderTask_BackwardPassParams *MR_UiRenderManager_beginBackwardPass(MR_UiRenderManager *_this, MR_ViewportId viewport, MR_std_vector_std_shared_ptr_MR_BasicUiRenderTask *tasks);
 
// After the backward pass is performed, the parameters should be passed back into this function.
MRC_API void MR_UiRenderManager_finishBackwardPass(MR_UiRenderManager *_this, const MR_BasicUiRenderTask_BackwardPassParams *params);
 
MRC_API void MR_IRenderObject_Destroy(const MR_IRenderObject *_this);
 
MRC_API void MR_IRenderObject_DestroyArray(const MR_IRenderObject *_this);
 
// Returns true if something was rendered, or false if nothing to render.
MRC_API bool MR_IRenderObject_render(MR_IRenderObject *_this, const MR_ModelRenderParams *params);
 
MRC_API void MR_IRenderObject_renderPicker(MR_IRenderObject *_this, const MR_ModelBaseRenderParams *params, uint32_t geomId);
 
MRC_API MR_uint64_t MR_IRenderObject_heapBytes(const MR_IRenderObject *_this);
 
MRC_API MR_uint64_t MR_IRenderObject_glBytes(const MR_IRenderObject *_this);
 
MRC_API void MR_IRenderObject_forceBindAll(MR_IRenderObject *_this);
 
MRC_API void MR_IRenderObject_renderUi(MR_IRenderObject *_this, const MR_UiRenderParams *params);
 
MRC_API const MR_IRenderObject *MR_IRenderObject_OffsetPtr(const MR_IRenderObject *ptr, ptrdiff_t i);
 
MRC_API MR_IRenderObject *MR_IRenderObject_OffsetMutablePtr(MR_IRenderObject *ptr, ptrdiff_t i);
 
#ifdef __cplusplus
} // extern "C"
#endif