File: image.rst

package info (click to toggle)
blender-doc 4.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 253,604 kB
  • sloc: python: 13,030; javascript: 322; makefile: 113; sh: 107
file content (155 lines) | stat: -rw-r--r-- 5,625 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
.. _bpy.types.ShaderNodeTexImage:

******************
Image Texture Node
******************

.. figure:: /images/node-types_ShaderNodeTexImage.webp
   :align: right
   :alt: Image Texture Node.

Used for applying an image as a texture.


Inputs
======

Vector
   3D coordinate that's projected onto the 2D image using the selected *Projection* method.
   The node then outputs the color and alpha at this projected point.

   This slot is usually connected to an output of the :doc:`/render/shader_nodes/input/texture_coordinate`.
   If left unconnected, the coordinate is taken from the object's active UV map (with Z = 0).


Properties
==========

Image
   Image data-block to use.

Interpolation
   Method to scale images up or down for rendering.

   .. same as in the Environment Texture node

   :Linear: Regular quality interpolation.
   :Cubic: Smoother, better quality interpolation. Bump maps should use this for best results.
   :Closest: No interpolation (nearest neighbor). Useful for rendering pixel art.
   :Smart: :guilabel:`Cycles Only`
      Only for Open Shading Language. Use cubic interpolation when scaling up and linear when scaling down,
      for better performance and sharpness.

Projection
   How to project *Vector* onto the image for arriving at a color.

   :Flat:
      Place the image in a unit square (stretching from (0, 0, 0) to (1, 1, 0))
      and project the *Vector* vertically onto it. This projection is typically used in combination
      with UV maps.
   :Box:
      Place the image on each side of a unit cube (stretching from (0, 0, 0) to (1, 1, 1))
      and project the *Vector* onto this cube, along the axis that's closest to the mesh normal.
      This projection is commonly used in architectural models considering these have lots of
      box-shaped objects.

      Blend
         Rather than projecting onto just one side (which creates sharp transitions), project onto
         multiple sides and blend the results together. The higher the value, the more blending and
         the smoother the result.

   :Sphere:
      Wrap the image around a sphere with origin (0.5, 0.5, 0.5), and project the *Vector* from
      this origin onto this sphere. This projection is, of course, perfect for spherical objects
      such as planets, and is also useful for organic objects.
   :Tube:
      Wrap the image around a cylinder with base (0.5, 0.5, 0) and height 1, and project the
      *Vector* horizontally from the central axis onto this cylinder. This projection is useful for
      a label on a bottle, for example. However, it's not suited for the top or bottom side of objects.

   .. list-table::
      Projections demonstrated using "Object" texture coordinates

      * - .. figure:: /images/render_shader-nodes_textures_image_projection-flat.png

             Flat projection

        - .. figure:: /images/render_shader-nodes_textures_image_projection-box.png

             Box projection

      * - .. figure:: /images/render_shader-nodes_textures_image_projection-sphere.png

             Sphere projection

        - .. figure:: /images/render_shader-nodes_textures_image_projection-tube.png

             Tube projection

Extension
   How the image is extrapolated if *Vector* lies outside the regular (0, 0, 0) to (1, 1, 1) bounds:

   :Repeat: Repeat the image horizontally and vertically (tiling).
   :Extend: Extend the image by repeating the pixels on its edges.
   :Clip: Clip to the original image size and set all the exterior pixels values to transparent black.
   :Mirror: Repeatedly flip the image horizontally and vertically.

Source
   Type of image (Single Image, Movie...). See :doc:`/editors/image/image_settings`.

Frames
   How many frames of the Movie-type image (video) to play. Past this point, the video will be paused
   (unless *Cyclic* is enabled).

   If you want to play the whole video, you can click
   :ref:`Match Movie Length <bpy.ops.image.match_movie_length>` in the Image Editor's Sidebar,
   then copy the *Frames* from there to the node.

Start Frame
   Scene frame at which the video should start playing.

Offset
   Number of frames to offset the video to an earlier point in time.
   (Put differently: how many frames at the start of the video to skip.)

   .. hint::

      Blender plays video textures at the scene framerate, not their original framerate,
      meaning they'll be faster or slower than intended if these framerates don't match up.
      You can put a :doc:`Driver </animation/drivers/introduction>` on the Offset to work
      around this. Simply type the following into the field, replacing *StartFrame*,
      *VideoFrameRate* and *SceneFrameRate* by their respective numbers:

      #(frame - StartFrame) * (VideoFrameRate - SceneFrameRate) / SceneFrameRate

Cyclic
   Start over after the last frame to create a continuous loop.

Auto Refresh
   Update the video texture in the 3D Viewport when moving through the timeline.

Color Space
   The :term:`Color Space` the image file was saved in.
   See :ref:`Image Settings <bpy.types.ColorManagedInputColorspaceSettings.name>` for details.

Alpha
   How the image uses its :term:`Alpha Channel`.
   See :ref:`Image Settings <bpy.types.Image.alpha_mode>` for details.


Outputs
=======

Color
   RGB color from image. If the image has transparency, the color is premultiplied if the Alpha output is used,
   and unpremultiplied (straight) otherwise.
Alpha
   Alpha channel from image.


Examples
========

.. figure:: /images/render_shader-nodes_textures_image_example.jpg

   Image texture from `GoodTextures.com <https://www.goodtextures.com/>`__.