e955c94ed3
Listing the "Blender Foundation" as copyright holder implied the Blender Foundation holds copyright to files which may include work from many developers. While keeping copyright on headers makes sense for isolated libraries, Blender's own code may be refactored or moved between files in a way that makes the per file copyright holders less meaningful. Copyright references to the "Blender Foundation" have been replaced with "Blender Authors", with the exception of `./extern/` since these this contains libraries which are more isolated, any changed to license headers there can be handled on a case-by-case basis. Some directories in `./intern/` have also been excluded: - `./intern/cycles/` it's own `AUTHORS` file is planned. - `./intern/opensubdiv/`. An "AUTHORS" file has been added, using the chromium projects authors file as a template. Design task: #110784 Ref !110783.
79 lines
2.2 KiB
C++
79 lines
2.2 KiB
C++
/* SPDX-FileCopyrightText: 2021 Blender Authors
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0-or-later */
|
|
|
|
/** \file
|
|
* \ingroup draw_engine
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
namespace blender::draw::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::draw::image_engine
|