920e709069
When using clangd or running clang-tidy on headers there are currently many errors. These are noisy in IDEs, make auto fixes impossible, and break features like code completion, refactoring and navigation. This makes source/blender headers work by themselves, which is generally the goal anyway. But #includes and forward declarations were often incomplete. * Add #includes and forward declarations * Add IWYU pragma: export in a few places * Remove some unused #includes (but there are many more) * Tweak ShaderCreateInfo macros to work better with clangd Some types of headers still have errors, these could be fixed or worked around with more investigation. Mostly preprocessor template headers like NOD_static_types.h. Note that that disabling WITH_UNITY_BUILD is required for clangd to work properly, otherwise compile_commands.json does not contain the information for the relevant source files. For more details see the developer docs: https://developer.blender.org/docs/handbook/tooling/clangd/ Pull Request: https://projects.blender.org/blender/blender/pulls/132608
85 lines
2.3 KiB
C++
85 lines
2.3 KiB
C++
/* SPDX-FileCopyrightText: 2021 Blender Authors
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0-or-later */
|
|
|
|
/** \file
|
|
* \ingroup draw_engine
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
struct ARegion;
|
|
struct ImBuf;
|
|
struct Image;
|
|
struct ImageUser;
|
|
struct Main;
|
|
|
|
namespace blender::image_engine {
|
|
|
|
struct ShaderParameters;
|
|
|
|
/**
|
|
* Space accessor.
|
|
*
|
|
* Image engine is used to draw the images inside multiple spaces \see SpaceLink.
|
|
* The #AbstractSpaceAccessor is an interface to communicate with a space.
|
|
*/
|
|
class AbstractSpaceAccessor {
|
|
public:
|
|
virtual ~AbstractSpaceAccessor() = default;
|
|
|
|
/**
|
|
* Return the active image of the space.
|
|
*
|
|
* The returned image will be drawn in the space.
|
|
*
|
|
* The return value is optional.
|
|
*/
|
|
virtual ::Image *get_image(Main *bmain) = 0;
|
|
|
|
/**
|
|
* Return the #ImageUser of the space.
|
|
*
|
|
* The return value is optional.
|
|
*/
|
|
virtual ImageUser *get_image_user() = 0;
|
|
|
|
/**
|
|
* Acquire the image buffer of the image.
|
|
*
|
|
* \param image: Image to get the buffer from. Image is the same as returned from the #get_image
|
|
* member.
|
|
* \param lock: pointer to a lock object.
|
|
* \return Image buffer of the given image.
|
|
*/
|
|
virtual ImBuf *acquire_image_buffer(::Image *image, void **lock) = 0;
|
|
|
|
/**
|
|
* Release a previous locked image from #acquire_image_buffer.
|
|
*/
|
|
virtual void release_buffer(::Image *image, ImBuf *image_buffer, void *lock) = 0;
|
|
|
|
/**
|
|
* Update the r_shader_parameters with space specific settings.
|
|
*
|
|
* Only update the #ShaderParameters.flags and #ShaderParameters.shuffle. Other parameters
|
|
* are updated inside the image engine.
|
|
*/
|
|
virtual void get_shader_parameters(ShaderParameters &r_shader_parameters,
|
|
ImBuf *image_buffer) = 0;
|
|
|
|
/** \brief Is (wrap) repeat option enabled in the space. */
|
|
virtual bool use_tile_drawing() const = 0;
|
|
|
|
/**
|
|
* \brief Initialize r_uv_to_texture matrix to transform from normalized screen space coordinates
|
|
* (0..1) to texture space UV coordinates.
|
|
*/
|
|
virtual void init_ss_to_texture_matrix(const ARegion *region,
|
|
const float image_offset[2],
|
|
const float image_resolution[2],
|
|
float r_uv_to_texture[4][4]) const = 0;
|
|
};
|
|
|
|
} // namespace blender::image_engine
|