Files
test/source/blender/freestyle/intern/stroke/ContextFunctions.h
Campbell Barton e955c94ed3 License Headers: Set copyright to "Blender Authors", add AUTHORS
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.
2023-08-16 00:20:26 +10:00

96 lines
2.7 KiB
C++

/* SPDX-FileCopyrightText: 2023 Blender Authors
*
* SPDX-License-Identifier: GPL-2.0-or-later */
#pragma once
/** \file
* \ingroup freestyle
* \brief Functions related to context queries
* \brief Interface to access the context related information.
*/
#include "Canvas.h"
#include "../image/GaussianFilter.h"
#include "../image/Image.h"
namespace Freestyle {
//
// Context Functions definitions
//
///////////////////////////////////////////////////////////
/** namespace containing all the Context related functions */
namespace ContextFunctions {
// GetTimeStamp
/** Returns the system time stamp */
uint GetTimeStampCF();
// GetCanvasWidth
/** Returns the canvas width */
uint GetCanvasWidthCF();
// GetCanvasHeight
/** Returns the canvas height */
uint GetCanvasHeightCF();
// GetBorder
/** Returns the border */
BBox<Vec2i> GetBorderCF();
// Load map
/** Loads an image map for further reading */
void LoadMapCF(const char *iFileName,
const char *iMapName,
uint iNbLevels = 4,
float iSigma = 1.0f);
// ReadMapPixel
/** Reads a pixel in a user-defined map
* \return the floating value stored for that pixel
* \param iMapName:
* The name of the map
* \param level:
* The level of the pyramid in which we wish to read the pixel
* \param x:
* The x-coordinate of the pixel we wish to read. The origin is in the lower-left corner.
* \param y:
* The y-coordinate of the pixel we wish to read. The origin is in the lower-left corner.
*/
float ReadMapPixelCF(const char *iMapName, int level, uint x, uint y);
// ReadCompleteViewMapPixel
/** Reads a pixel in the complete view map
* \return the floating value stored for that pixel
* \param level:
* The level of the pyramid in which we wish to read the pixel
* \param x:
* The x-coordinate of the pixel we wish to read. The origin is in the lower-left corner.
* \param y:
* The y-coordinate of the pixel we wish to read. The origin is in the lower-left corner.
*/
float ReadCompleteViewMapPixelCF(int level, uint x, uint y);
// ReadOrientedViewMapPixel
/** Reads a pixel in one of the oriented view map images
* \return the floating value stored for that pixel
* \param iOrientation:
* The number telling which orientation we want to check
* \param level:
* The level of the pyramid in which we wish to read the pixel
* \param x:
* The x-coordinate of the pixel we wish to read. The origin is in the lower-left corner.
* \param y:
* The y-coordinate of the pixel we wish to read. The origin is in the lower-left corner.
*/
float ReadDirectionalViewMapPixelCF(int iOrientation, int level, uint x, uint y);
// DEBUG
FEdge *GetSelectedFEdgeCF();
} // end of namespace ContextFunctions
} /* namespace Freestyle */