sk_app::Window Class Reference

#include <Window.h>

Inheritance diagram for sk_app::Window:

Classes
class	Layer

Public Types
enum	BackendType { kRaster_BackendType , kLast_BackendType = kRaster_BackendType }
enum	{ kBackendTypeCount = kLast_BackendType + 1 }

Public Member Functions
virtual	~Window ()
virtual void	setTitle (const char *)=0
virtual void	show ()=0
virtual void	setUIState (const char *)
virtual const char *	getClipboardText ()
virtual void	setClipboardText (const char *)
void	inval ()
virtual bool	scaleContentToFit () const
virtual bool	attach (BackendType)=0
void	detach ()
void	pushLayer (Layer *layer)
void	onBackendCreated ()
bool	onChar (SkUnichar c, skui::ModifierKey modifiers)
bool	onKey (skui::Key key, skui::InputState state, skui::ModifierKey modifiers)
bool	onMouse (int x, int y, skui::InputState state, skui::ModifierKey modifiers)
bool	onMouseWheel (float delta, int x, int y, skui::ModifierKey modifiers)
bool	onTouch (intptr_t owner, skui::InputState state, float x, float y)
bool	onFling (skui::InputState state)
bool	onPinch (skui::InputState state, float scale, float x, float y)
void	onUIStateChanged (const SkString &stateName, const SkString &stateValue)
void	onPaint ()
void	onResize (int width, int height)
void	onActivate (bool isActive)
int	width () const
int	height () const
virtual float	scaleFactor () const
virtual const DisplayParams &	getRequestedDisplayParams ()
virtual void	setRequestedDisplayParams (const DisplayParams &, bool allowReattach=true)
int	sampleCount () const
int	stencilBits () const
GrDirectContext *	directContext () const
skgpu::graphite::Context *	graphiteContext () const
skgpu::graphite::Recorder *	graphiteRecorder () const

Static Public Member Functions
static Window *	CreateNativeWindow (void *platformData)

Protected Member Functions
	Window ()
virtual void	onInval ()=0
void	markInvalProcessed ()
void	visitLayers (const std::function< void(Layer *)> &visitor)
bool	signalLayers (const std::function< bool(Layer *)> &visitor)

Protected Attributes
SkTDArray< Layer * >	fLayers
DisplayParams	fRequestedDisplayParams
bool	fIsActive = true
std::unique_ptr< skwindow::WindowContext >	fWindowContext
bool	fIsContentInvalidated = false

Detailed Description

Definition at line 40 of file Window.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
kBackendTypeCount

Definition at line 94 of file Window.h.

         {
        kBackendTypeCount = kLast_BackendType + 1
    };

BackendType

enum sk_app::Window::BackendType

Enumerator
kRaster_BackendType
kLast_BackendType

Definition at line 63 of file Window.h.

                     {
#ifdef SK_GL
        kNativeGL_BackendType,
#endif
#if SK_ANGLE && (defined(SK_BUILD_FOR_WIN) || defined(SK_BUILD_FOR_MAC))
        kANGLE_BackendType,
#endif
#ifdef SK_DAWN
#if defined(SK_GRAPHITE)
        kGraphiteDawn_BackendType,
#endif
#endif
#ifdef SK_VULKAN
        kVulkan_BackendType,
#if defined(SK_GRAPHITE)
        kGraphiteVulkan_BackendType,
#endif
#endif
#ifdef SK_METAL
        kMetal_BackendType,
#if defined(SK_GRAPHITE)
        kGraphiteMetal_BackendType,
#endif
#endif
#ifdef SK_DIRECT3D
        kDirect3D_BackendType,
#endif
        kRaster_BackendType,
 
        kLast_BackendType = kRaster_BackendType
    };

Constructor & Destructor Documentation

~Window()

Window::~Window ( )

virtual

Definition at line 23 of file Window.cpp.

{}

Window()

Window::Window ( )

protected

Definition at line 21 of file Window.cpp.

{}

Member Function Documentation

attach()

virtual bool sk_app::Window::attach ( BackendType  )

pure virtual

Implemented in sk_app::Window_android, sk_app::Window_ios, sk_app::Window_mac, sk_app::Window_unix, and sk_app::Window_win.

CreateNativeWindow()

Window * Window::CreateNativeWindow ( void *  platformData )

static

Definition at line 14 of file Window_android.cpp.

                                                     {
    Window_android* window = new Window_android();
    if (!window->init((SkiaAndroidApp*)platformData)) {
        delete window;
        return nullptr;
    }
    return window;
}

detach()

void Window::detach

(

)

Definition at line 25 of file Window.cpp.

{ fWindowContext = nullptr; }

directContext()

GrDirectContext * Window::directContext

(

)

const

Definition at line 158 of file Window.cpp.

                                             {
    if (!fWindowContext) {
        return nullptr;
    }
    return fWindowContext->directContext();
}

getClipboardText()

virtual const char * sk_app::Window::getClipboardText ( )

inlinevirtual

Reimplemented in sk_app::Window_unix.

Definition at line 53 of file Window.h.

{ return nullptr; }

getRequestedDisplayParams()

virtual const DisplayParams & sk_app::Window::getRequestedDisplayParams ( )

inlinevirtual

Definition at line 155 of file Window.h.

{ return fRequestedDisplayParams; }

graphiteContext()

skgpu::graphite::Context * Window::graphiteContext

(

)

const

Definition at line 165 of file Window.cpp.

                                                    {
#if defined(SK_GRAPHITE)
    if (!fWindowContext) {
        return nullptr;
    }
    return fWindowContext->graphiteContext();
#else
    return nullptr;
#endif
}

graphiteRecorder()

skgpu::graphite::Recorder * Window::graphiteRecorder

(

)

const

Definition at line 176 of file Window.cpp.

                                                      {
#if defined(SK_GRAPHITE)
    if (!fWindowContext) {
        return nullptr;
    }
    return fWindowContext->graphiteRecorder();
#else
    return nullptr;
#endif
}

height()

int Window::height

(

)

const

Definition at line 130 of file Window.cpp.

                         {
    if (!fWindowContext) {
        return 0;
    }
    return fWindowContext->height();
}

inval()

void Window::inval

(

)

Definition at line 195 of file Window.cpp.

                   {
    if (!fWindowContext) {
        return;
    }
    if (!fIsContentInvalidated) {
        fIsContentInvalidated = true;
        onInval();
    }
}

markInvalProcessed()

void Window::markInvalProcessed ( )

protected

Definition at line 205 of file Window.cpp.

                                {
    fIsContentInvalidated = false;
}

onActivate()

void Window::onActivate

(

bool

isActive

)

Definition at line 116 of file Window.cpp.

                                     {
    if (fWindowContext) {
        fWindowContext->activate(isActive);
    }
    fIsActive = isActive;
}

onBackendCreated()

void Window::onBackendCreated

(

)

Definition at line 44 of file Window.cpp.

                              {
    this->visitLayers([](Layer* layer) { layer->onBackendCreated(); });
}

onChar()

bool Window::onChar	(	SkUnichar	c,
		skui::ModifierKey	modifiers
	)

Definition at line 48 of file Window.cpp.

                                                          {
    return this->signalLayers([=](Layer* layer) { return layer->onChar(c, modifiers); });
}

onFling()

bool Window::onFling

(

skui::InputState

state

)

Definition at line 69 of file Window.cpp.

                                         {
    return this->signalLayers([=](Layer* layer) { return layer->onFling(state); });
}

onInval()

virtual void sk_app::Window::onInval ( )

protectedpure virtual

Implemented in sk_app::Window_android, sk_app::Window_ios, sk_app::Window_mac, sk_app::Window_unix, and sk_app::Window_win.

onKey()

bool Window::onKey	(	skui::Key	key,
		skui::InputState	state,
		skui::ModifierKey	modifiers
	)

Definition at line 52 of file Window.cpp.

                                                                               {
    return this->signalLayers([=](Layer* layer) { return layer->onKey(key, state, modifiers); });
}

onMouse()

bool Window::onMouse	(	int	x,
		int	y,
		skui::InputState	state,
		skui::ModifierKey	modifiers
	)

Definition at line 56 of file Window.cpp.

                                                                                  {
    return this->signalLayers([=](Layer* layer) { return layer->onMouse(x, y, state, modifiers); });
}

onMouseWheel()

bool Window::onMouseWheel	(	float	delta,
		int	x,
		int	y,
		skui::ModifierKey	modifiers
	)

Definition at line 60 of file Window.cpp.

                                                                              {
    return this->signalLayers(
            [=](Layer* layer) { return layer->onMouseWheel(delta, x, y, modifiers); });
}

onPaint()

void Window::onPaint

(

)

Definition at line 81 of file Window.cpp.

                     {
    if (!fWindowContext) {
        return;
    }
    if (!fIsActive) {
        return;
    }
    sk_sp<SkSurface> backbuffer = fWindowContext->getBackbufferSurface();
    if (backbuffer == nullptr) {
        printf("no backbuffer!?\n");
        // TODO: try recreating testcontext
        return;
    }
 
    markInvalProcessed();
 
    // draw into the canvas of this surface
    this->visitLayers([](Layer* layer) { layer->onPrePaint(); });
    this->visitLayers([=](Layer* layer) { layer->onPaint(backbuffer.get()); });
 
    if (auto dContext = this->directContext()) {
        dContext->flushAndSubmit(backbuffer.get(), GrSyncCpu::kNo);
    }
 
    fWindowContext->swapBuffers();
}

onPinch()

bool Window::onPinch	(	skui::InputState	state,
		float	scale,
		float	x,
		float	y
	)

Definition at line 73 of file Window.cpp.

                                                                        {
    return this->signalLayers([=](Layer* layer) { return layer->onPinch(state, scale, x, y); });
}

onResize()

void Window::onResize	(	int	width,
		int	height
	)

Definition at line 108 of file Window.cpp.

                                  {
    if (!fWindowContext) {
        return;
    }
    fWindowContext->resize(w, h);
    this->visitLayers([=](Layer* layer) { layer->onResize(w, h); });
}

onTouch()

bool Window::onTouch	(	intptr_t	owner,
		skui::InputState	state,
		float	x,
		float	y
	)

Definition at line 65 of file Window.cpp.

                                                                           {
    return this->signalLayers([=](Layer* layer) { return layer->onTouch(owner, state, x, y); });
}

onUIStateChanged()

void Window::onUIStateChanged	(	const SkString &	stateName,
		const SkString &	stateValue
	)

Definition at line 77 of file Window.cpp.

                                                                                   {
    this->visitLayers([=](Layer* layer) { layer->onUIStateChanged(stateName, stateValue); });
}

pushLayer()

void sk_app::Window::pushLayer ( Layer *  layer )

inline

Definition at line 132 of file Window.h.

                                 {
        layer->onAttach(this);
        fLayers.push_back(layer);
    }

sampleCount()

int Window::sampleCount

(

)

const

Definition at line 144 of file Window.cpp.

                              {
    if (!fWindowContext) {
        return 0;
    }
    return fWindowContext->sampleCount();
}

scaleContentToFit()

virtual bool sk_app::Window::scaleContentToFit ( ) const

inlinevirtual

Reimplemented in sk_app::Window_android.

Definition at line 61 of file Window.h.

{ return false; }

scaleFactor()

virtual float sk_app::Window::scaleFactor ( ) const

inlinevirtual

Reimplemented in sk_app::Window_mac.

Definition at line 153 of file Window.h.

{ return 1.0f; }

setClipboardText()

virtual void sk_app::Window::setClipboardText ( const char *  )

inlinevirtual

Reimplemented in sk_app::Window_unix.

Definition at line 54 of file Window.h.

{}

setRequestedDisplayParams()

void Window::setRequestedDisplayParams ( const DisplayParams &  params, bool  allowReattach = true  )

virtual

Reimplemented in sk_app::Window_unix, and sk_app::Window_win.

Definition at line 137 of file Window.cpp.

                                                                          {
    fRequestedDisplayParams = params;
    if (fWindowContext) {
        fWindowContext->setDisplayParams(fRequestedDisplayParams);
    }
}

setTitle()

virtual void sk_app::Window::setTitle ( const char *  )

pure virtual

Implemented in sk_app::Window_android, sk_app::Window_ios, sk_app::Window_mac, sk_app::Window_unix, and sk_app::Window_win.

setUIState()

virtual void sk_app::Window::setUIState ( const char *  )

inlinevirtual

Reimplemented in sk_app::Window_android.

Definition at line 50 of file Window.h.

{}

show()

virtual void sk_app::Window::show ( )

pure virtual

Implemented in sk_app::Window_android, sk_app::Window_ios, sk_app::Window_mac, sk_app::Window_unix, and sk_app::Window_win.

signalLayers()

bool Window::signalLayers ( const std::function< bool(Layer *)> &  visitor )

protected

Definition at line 35 of file Window.cpp.

                                                                  {
    for (int i = fLayers.size() - 1; i >= 0; --i) {
        if (fLayers[i]->fActive && visitor(fLayers[i])) {
            return true;
        }
    }
    return false;
}

stencilBits()

int Window::stencilBits

(

)

const

Definition at line 151 of file Window.cpp.

                              {
    if (!fWindowContext) {
        return -1;
    }
    return fWindowContext->stencilBits();
}

visitLayers()

void Window::visitLayers ( const std::function< void(Layer *)> &  visitor )

protected

Definition at line 27 of file Window.cpp.

                                                                 {
    for (int i = 0; i < fLayers.size(); ++i) {
        if (fLayers[i]->fActive) {
            visitor(fLayers[i]);
        }
    }
}

width()

int Window::width

(

)

const

Definition at line 123 of file Window.cpp.

                        {
    if (!fWindowContext) {
        return 0;
    }
    return fWindowContext->width();
}

Member Data Documentation

fIsActive

bool sk_app::Window::fIsActive = true

protected

Definition at line 177 of file Window.h.

fIsContentInvalidated

bool sk_app::Window::fIsContentInvalidated = false

protected

Definition at line 186 of file Window.h.

fLayers

SkTDArray<Layer*> sk_app::Window::fLayers

protected

Definition at line 175 of file Window.h.

fRequestedDisplayParams

DisplayParams sk_app::Window::fRequestedDisplayParams

protected

Definition at line 176 of file Window.h.

fWindowContext

std::unique_ptr<skwindow::WindowContext> sk_app::Window::fWindowContext

protected

Definition at line 179 of file Window.h.

---

The documentation for this class was generated from the following files:

• third_party/skia/tools/sk_app/Window.h
• third_party/skia/tools/sk_app/android/Window_android.cpp
• third_party/skia/tools/sk_app/ios/Window_ios.mm
• third_party/skia/tools/sk_app/mac/Window_mac.mm
• third_party/skia/tools/sk_app/unix/Window_unix.cpp
• third_party/skia/tools/sk_app/win/Window_win.cpp
• third_party/skia/tools/sk_app/Window.cpp